VibeFox Windcave for WooCommerce — ヘルプ
要件
WordPress: 6.0 以降。
WooCommerce: 8.0 以降。インストールされて有効になっている必要があります。WooCommerce がないと、プラグインは有効化できません。
PHP: 8.0 以降。
Windcave アカウント: REST API 認証情報(API ユーザー名と API キー)を持つ Windcave 加盟店アカウントが必要です。Windcave は、UAT テスト環境(uat.windcave.com)と本番環境(sec.windcave.com)の認証情報をそれぞれ個別に発行します。Windcave のサポートまたはアカウントマネージャーに問い合わせてください。PxPay キーはこのプラグインでは使用できません。提供したい決済方法(カード、ウォレットなど)は、Windcave アカウントで有効にしておく必要があります。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_windcave_payment_gateway フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます:WooCommerce > Settings > Payments > Windcave > Manage、またはプラグインページでプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. REST API のユーザー名とキーを入力します。テストモードでは UAT の認証情報を、実際の決済では本番の認証情報を入力してください(「設定」を参照)。
6. 取引タイプと決済方法を選択し、Enable/Disable をオンにして保存します。Test mode をオンにしてテスト決済を行い、その後 Test mode をオフにすると、実際の決済を受け付けられます。
設定
すべての設定は 1 つのページにあります:WooCommerce > Settings > Payments > Windcave。テストモードがオンの間は、ページに Test mode is on: payments go to the Windcave UAT environment and no real money is taken. と表示されます。決済方法の一覧では、現在のモードに API ユーザー名と API キーの両方が設定されるまで、Windcave は「設定が必要」と表示されます。プラグインのバージョンはページ下部に表示されます。
一般
Enable/Disable: Enable Windcave payments で決済方法のオン/オフを切り替えます。デフォルト:オフ。
Title: チェックアウト時に購入者に表示される決済方法の名前。デフォルト:Credit/Debit Card (Windcave)。
Description: チェックアウト時に決済方法の下に表示されるテキスト。デフォルト:You will be redirected to the secure Windcave payment page to complete your payment.
Windcave REST API
Windcave から発行された REST API 認証情報(ユーザー名と API キー。PxPay キーではありません)を入力します。本番環境と UAT の認証情報は並べて保存できます。テストモードでは UAT の認証情報のみを使用し、ライブモードでは本番の認証情報のみを使用します。
Test mode: Use the Windcave UAT test environment (uat.windcave.com)。実際の料金は請求されません。新しい決済には UAT の認証情報が使用されます。返金とキャプチャは、注文が支払われた環境に対して常に行われます。デフォルト:オフ。
Production API username: sec.windcave.com 用の REST API ユーザー名。
Production API key: sec.windcave.com 用の REST API キー。
UAT API username: uat.windcave.com(テストモード)用の REST API ユーザー名。
UAT API key: uat.windcave.com(テストモード)用の REST API キー。
決済
Transaction type: 決済の請求方法。デフォルト:Purchase。
Payment methods: Windcave の決済ページに表示される方法:Cards、Account2Account(ニュージーランドの銀行振込)、Apple Pay、Google Pay、PayPal、Alipay、WeChat Pay、UnionPay、Interac、humm。これらは Windcave アカウントで有効になっている必要があります。フィールドを空のままにすると、アカウントで有効なすべての決済方法が表示されます。デフォルト:Cards。
詳細設定
Debug log: Log API requests and payment events。ログは WooCommerce > Status > Logs にあり、ソースは wcp_windcave_payment_gateway です。エラーと警告は常に記録されます。このオプションを有効にすると、API リクエストと決済イベントも記録されます。API キー、カード情報、購入者の個人データはマスクされます。デフォルト:オフ。
Clean uninstall: Delete the plugin settings and logs when the plugin is deleted。注文に保存された決済データ(返金に必要な Windcave トランザクション ID)は、常に保持されます。デフォルト:オフ。
通知 URL
Windcave で通知 URL を設定する必要はありません。プラグインは、決済セッションごとに戻り先アドレスと通知先アドレスを送信します。Windcave は通知(Fail-Proof Result Notification)を https://your-site/wc-api/windcave_p_notification/ に送信します。購入者の戻りも通知も Windcave による署名はないため、プラグインはそれ単独では信頼しません。常にセッションを作成した環境の認証情報を使用して、Windcave REST API からセッションの結果を取得します。
チェックアウト
購入者は決済方法(デフォルトは Credit/Debit Card (Windcave))を選択し、注文を確定します。プラグインは、注文の合計金額を注文通貨で Windcave 決済セッションとして作成し、購入者を Windcave Hosted Payment Page に移動させます。注文番号は加盟店参照番号として、ストアの言語、購入者の氏名、メールアドレス、電話番号、請求先住所および配送先住所とともに送信されます。テストモードでは、チェックアウトブロックの決済方法の下に Test mode: payments go to the Windcave UAT environment, no real money is taken. と表示されます。
決済後、購入者はストアの注文受付ページに戻ります。注文は、Windcave が確認した後にのみ支払い済みになります。プラグインは、購入者が戻ってきたときと Windcave からの通知が届いたときの両方で、Windcave REST API にセッションの結果を照会します。注文ごとのロックにより、決済が一度だけ適用されることが保証されます。結果がまだ判明していない場合、注文受付ページは再度確認し、We are waiting for Windcave to confirm your payment. You will receive an e-mail as soon as it is confirmed — please do not pay again. と表示します。
購入者が決済を完了せずに戻った場合、チェックアウトページ(試行が Pay for order ページで始まった場合はそのページ)に次のいずれかのメッセージが表示されます。
購入者が支払うまで、カートは空にならず、在庫も減りません。購入者は、未払いの注文を、たとえば Pay for order ページから再度支払うことができます。新しい試行では、まず前回のセッションを確認します。すでに支払い済みであれば、2 回目の決済は作成されません。購入者が決済ページを一度も使用しておらず、注文が変更されていない場合は、同じページに戻されます。その時点で前回の決済が確認中の場合、購入者には Your previous payment for this order is being confirmed right now. Please wait a minute and check your e-mail before trying again. と表示されます。
Windcave が決済を開始できない場合、購入者には短いメッセージが表示されます。この注文の詳細では Windcave が決済を開始できなかったこと、または決済サービスが一時的に利用できないことが示されます。理由は注文メモに追加されます。現在のモードに認証情報がない場合、購入者には This payment method is not available at the moment. Please choose another payment method or contact us. と表示されます。
この決済方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce High-Performance Order Storage(HPOS)に対応しています。
本プラグインには、サブスクリプションや定期決済、保存済みカード、サイト上に埋め込まれたカードフォーム(購入者は常に Windcave のページで支払います)はありません。また、PxPay 2.0 API には対応しておらず、追加料金も発生しません。Windcave が追加料金を加算した場合、注文はメインの取引と照合されます。
注文と返金
注文ステータス
Pending payment: 購入者は Windcave に移動しましたが、まだ支払っていないか、Windcave がまだ決済を確認していません。購入者がキャンセルしたり、セッションが期限切れになったりした場合、注文は支払い待ちのままとなり、メモが追加されます。
Processing or Completed: Purchase 決済が確認されました。WooCommerce は通常どおり、注文を処理中に設定します。配送が不要な注文の場合は完了に設定されます。注文メモには、金額、Windcave トランザクション ID、承認コード、カードの種類とマスクされたカード番号、環境(UAT または本番)が表示されます。注文のトランザクション ID は、Windcave トランザクション ID です。
On hold (authorised): Auth 決済は承認されましたが、まだキャプチャされていません。注文メモには、キャプチャまたは解除の方法が記載されています。
On hold (does not match): Windcave から報告された金額、通貨、加盟店参照番号、または取引タイプが注文と異なります(たとえば、決済の開始後に注文が編集された場合)。メモには相違点が一覧表示されます。発送前に Windcave Payline で決済を確認し、必要に応じて返金してください。
Failed: 決済が拒否されました。メモには Windcave のレスポンステキストとコードが表示されます。購入者は再度お試しいただけます。
キャンセルされた注文に対して承認済みの決済が届いた場合、または支払い済みの注文に対して 2 回目の承認済み決済が届いた場合、注文は変更されません。トランザクション ID を含むメモで、Windcave Payline での返金(またはキャンセルされた注文の手動復元)が求められます。
キャプチャ(Auth モード)
注文を開き、注文操作で Capture Windcave payment を選択し、更新ボタンをクリックします。この操作は、まだキャプチャまたは解除されていない承認がある保留中の注文にのみ表示されます。注文の全額がキャプチャされ、そのキャプチャは注文メモに追加されて、注文は支払い済みの注文として進みます(通常は処理中)。Windcave がキャプチャを受け付けない場合、注文画面に Windcave capture failed: と理由が表示され、理由は注文メモに追加されます。
返金
注文を開き、Refund をクリックして金額を入力し、Refund via Windcave をクリックします。全額返金と一部返金に対応しています。返金は、決済が行われた環境(UAT または本番)とアカウントに送信されるため、その環境の認証情報が保存されている必要があります。返金が成功すると、Windcave トランザクション ID とともに注文メモに追加されます。
キャプチャされていない Auth 決済の場合、全額返金のみ可能です。これにより承認が解除(取り消し)されます。一部の金額を指定するとエラーが表示され、全額を返金するか、先に決済をキャプチャするよう求められます。
Windcave が返金を拒否した場合、WooCommerce は理由とともに Windcave declined the refund: を表示し、返金は記録されません。Windcave がまだ返金を処理中の場合、WooCommerce は Windcave has not confirmed the refund yet. See the order notes. を表示し、返金は記録されません。Windcave Payline で取引を確認してください。承認されていれば返金を手動で記録し、承認されていなければ再度お試しください。同じ返金の再試行が Windcave に 2 回送信されることはありません。Windcave Payline で行われた返金は、ストアには通知されません。
ライセンスキー
プラグインは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > Windcave の上部にあります。キーを License key に貼り付けて、Activate をクリックします。ブロックには、ステータス(ライセンスの有効期限日など)とお使いのドメインが表示されます。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクから、vibefox.net のアカウントを開けます。
1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、Windcave はチェックアウトで購入者に表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、決済方法が (unlicensed — visible to admins only) と表示された状態で引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインページと WooCommerce のページには、リマインダーが表示されます。既存の注文には影響しません。すでに開始された決済は引き続き確認され、返金とキャプチャも動作します。
ライセンスの期限が切れても、プラグインは動作を続けますが、アップデートとサポートには更新が必要です。ステータスは、バックグラウンドで自動的に再確認されます。
トラブルシューティング
Windcave does not appear at checkout: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードに両方の認証情報があることを確認してください。テストモードでは UAT API username と UAT API key、本番(ライブ)モードでは Production API username と Production API key が必要です。
The payment went through, but the order stays Pending payment: プラグインはまだ Windcave から結果を取得できていません。注文メモを開いてください。セッションを確認できなかった時刻と理由がメモに記載されています。決済が行われた環境の認証情報が保存されていて、正しいことを確認してください。確認は、Windcave が通知を再送したとき(結果を確認できるまで、プラグインはエラーを返し、Windcave が再試行します)と、購入者が注文受付ページを開いたときに繰り返されます。サーバーは、https://your-site/wc-api/windcave_p_notification/ への Windcave からのリクエストを受け付ける必要があります。
Authentication failed in the order notes or the log: REST API のユーザー名またはキーが間違っているか、別の環境のものです。UAT の認証情報はテストモードでのみ、本番の認証情報はライブモードでのみ使用できます。PxPay キーは使用できません。
The customer sees that Windcave could not start the payment with the details of this order: Windcave が、通貨や、アカウントで有効になっていない決済方法などの理由で、セッションのリクエストを拒否しました。正確な理由は注文メモとログに記載されています。
Order is On hold after payment: 注文メモを確認してください。決済がキャプチャ待ちの Auth であるか、支払われた金額、通貨、または加盟店参照番号が注文と異なっていたかのいずれかです。決済をキャプチャ、出荷、または返金してください。
Test payments and live payments: UAT と本番は分けて管理されます。各セッションは作成された環境で確認され、返金とキャプチャは、後で Test mode を切り替えた場合でも、決済の環境に送られます。プラグインのバージョン 1.0 で作成された注文は、旧設定 API URL の環境を使用します。
Refund fails with a message about the environment: 決済は UAT または本番で行われましたが、その環境の認証情報が保存されていません。認証情報を入力して、もう一度お試しください。
Capture Windcave payment is missing in the order actions: この操作は、Auth で支払われ、まだキャプチャまたは解除されていない保留中の注文にのみ表示されます。
Where to find details: エラーと警告は常に WooCommerce > Status > Logs に、ソース wcp_windcave_payment_gateway で書き込まれます。API リクエストと決済イベントも記録するには、Debug log をオンにしてください。
The license block shows an error: ブロックに表示されるメッセージに従ってください。たとえば、キーが別のドメインで既に使用されている場合は、vibefox.net のアカウントで枠を解放してから Check now をクリックします。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効にします。ライセンスサーバーに接続できない場合、プラグインは最後に確認されたステータスで動作を続けます。
アンインストール
プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページでプラグインを無効化してから削除します。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定、プラグインのオプション、ログ(ローテーションされたファイルを含むログファイルと、データベースのログエントリ)は、Clean uninstall がオンになっていた場合にのみ削除されます。それ以外の場合は、後で再インストールするために保持されます。既存の注文は、決済メモと Windcave トランザクション ID を保持します。
Windcave は各所有者の商標です。本プラグインは Windcave と提携しておらず、Windcave による承認も受けていません。
