VibeFox eWAY for WooCommerce — ヘルプ
要件
WordPress: 6.0 以降。
WooCommerce: 8.0 以降。インストールされ、有効であること。
PHP: 8.0 以降。
ストア通貨: AUD、NZD、SGD、HKD、MYR のいずれか。それ以外の通貨の場合、チェックアウトではこの決済方法は表示されません。注文は注文自体の通貨で請求されます。
eWAY アカウント: Rapid API へのアクセス権を持つ eWAY 加盟店アカウントと、その Rapid API キーおよびパスワードが必要です。キーとパスワードは MyeWAY の Settings, API Key から確認できます。テストには、専用のキーとパスワードを持つ eWAY サンドボックスアカウントが必要です。サンドボックスと本番のキーは別々のものです。eWAY 側で設定する必要はありません。戻り先 URL は決済のたびに送信されます。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ有効です。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に進み、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_eway_payment_gateway フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます: WooCommerce > Settings > Payments > eWAY > Manage。または、プラグインページのプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. サンドボックスの API キーとパスワードを入力し、Sandbox Mode はオンのままにして、Enable/Disable をオンにします。その後、eWAY のテストカード 4444333322221111 でテスト注文を行います。
6. 本番の API キーとパスワードを入力し、Sandbox Mode のチェックを外して保存します。
設定
すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > eWAY。入力欄の上のバッジにモードが表示されます。SANDBOX(決済は eWAY のサンドボックスに送られ、実際の料金は請求されません)または LIVE(本番の API キーで実際の決済が行われます)。現在のモードの API キーまたはパスワードが未入力の場合(その場合、チェックアウトにゲートウェイは表示されません)や、ストア通貨がサポートされていない場合は、ページに警告が表示されます。決済方法の一覧では、現在のモードに認証情報が設定されるまで、eWAY に設定が必要であることが表示されます。サンドボックスモードでは、テストモードのバッジが表示されます。
一般
Enable/Disable: Enable eWAY Payment Gateway で、この決済方法を有効または無効にします。デフォルト: 無効。
Title: チェックアウト時に購入者に表示される決済方法の名称です。デフォルト: Credit Card (eWAY)。
Description: チェックアウト時に決済方法の下に表示されるテキストです。デフォルト: Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.
API 認証情報
Rapid API キーとパスワードは、MyeWAY の Settings, API Key にあります。eWAY では本番用とサンドボックス用のキーの取得方法を解説しており、このセクションからリンクされています。サンドボックスと本番では異なるキーを使用します。
Sandbox Mode: Enable sandbox (test) mode は、サンドボックスのキーを使って決済を eWAY のサンドボックスに送信します。実際の料金は請求されません。デフォルト: オン。本番のキーで実際の決済を行う場合は、チェックを外します。
Live API Key: eWAY 本番アカウントの Rapid API キーです。
Live API Password: eWAY 本番アカウントの Rapid API パスワードです。
Sandbox API Key: eWAY サンドボックス(partner/developer)アカウントの Rapid API キーです。
Sandbox API Password: eWAY サンドボックスアカウントの Rapid API パスワードです。
注文
Order Status on Success: eWAY が決済を確認した後の注文ステータスです。
詳細
Debug log: Enable logging は、API 呼び出しと決済結果を WooCommerce > Status > Logs に書き込みます。ソースは wcp_eway_payment_gateway です。カード情報とキーは記録されません。エラーは常に記録されます。デフォルト: 無効。
Uninstall: Delete all plugin data on uninstall。チェックを入れると、プラグインの削除時にゲートウェイの設定とログが削除されます。注文に保存された決済参照情報は残ります。デフォルト: 無効。
チェックアウト
購入者は決済方法(デフォルトは Credit Card (eWAY))を選択して注文します。プラグインは、注文通貨で注文合計金額の決済ページを eWAY に要求します。その際、注文 ID を請求書の参照番号として、購入者の請求情報とともに送信し、購入者を eWAY の Responsive Shared Page に移動させます。そこで購入者はカードで支払います。決済は即時に売上確定されます。
支払い後、購入者は貴店に戻ります。プラグインはブラウザを信頼しません。この注文で作成された決済ページの結果を、サーバー間通信で eWAY に問い合わせます。注文が支払い済みとしてマークされるのは、eWAY が確認し、承認された金額と通貨が注文と一致した場合のみです。その後、購入者は「注文受付」ページに移動します。この時点で eWAY に問い合わせできなかった場合、注文は「支払い待ち」のままとなり、ページには We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again. と表示されます。決済は、「注文受付」ページを開いたとき、および WooCommerce が未払い注文を自動キャンセルする前に、再度確認されます。
決済が拒否された場合、購入者は理由とともにチェックアウト(または Pay for order ページ)に戻ります。例: Your payment was declined: Insufficient funds. Please try again or use a different payment method. 購入者が eWAY のページで Cancel をクリックした場合、プラグインはまず eWAY に問い合わせて、何も支払われていないことを確認します。チェックアウトで行われた注文はその後キャンセルされます。一方、Pay for order ページから行われた注文は未払いのままになります。購入者には You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. と表示されます。決済が完了しなかった場合のメッセージは The payment was not completed. Please try again. です。
購入者は未払いの注文を再度支払うことができます。注文のすべての決済ページは追跡されるため、以前のページでの支払いも正しく認識されます。eWAY が決済ページを作成できない場合、購入者には Payment error: Unable to connect to eWAY. Please try again. のような短いメッセージが表示されます。
この決済方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce の高パフォーマンス注文保存(HPOS)に対応しています。
eWAY は Shared Page 向けのサーバー間通知を送信しません。結果は、購入者が戻ったときと、上記の確認処理によって取得されます。プラグインは、貴サイト上にカード入力欄を持たず、カードの保存やサブスクリプションには対応しておらず、承認のみの後の売上確定にも対応していません。また、Beagle の不正スコアは評価しません(eWAY の不正検知ルールでブロックされた取引は、eWAY 自身が拒否します)。
注文と返金
注文ステータス
Pending payment: 購入者は eWAY に移動しましたが、まだ支払っていないか、eWAY から結果をまだ取得できていません(注文メモにその旨が記載されます)。
Processing or Completed: 決済が承認されました。ステータスは Order Status on Success に従います。注文メモには、eWAY の取引 ID、承認コード、レスポンスが表示されます。注文の取引 ID は eWAY の取引 ID です。
On hold after payment: eWAY が注文と異なる金額または通貨を承認した場合(例: Approved for partial amount。または、購入者が決済ページを開いた後に注文が編集された場合)、あるいは注文がキャンセルされた後に決済が承認された場合です。メモに理由が記載されます。「注文受付」ページでは、購入者に Your payment was received and is being reviewed by the store. We will contact you if anything is needed. と表示されます。注文を完了するか、決済を返金してください。
Failed: eWAY が決済を拒否しました。メモには eWAY のコードとその意味が表示されます。
Cancelled: 購入者がチェックアウトで注文した後、eWAY のページでキャンセルした場合、または eWAY が未払いであることを確認した後に、貴店の操作または WooCommerce の在庫保持タイムアウトによって注文がキャンセルされた場合です。
すでに支払い済みの注文に対して 2 回目の決済が承認された場合でも、注文は変更されません。メモには、MyeWAY で重複分を返金するよう案内が表示されます。
返金
注文を開き、Refund をクリックして金額を入力し、Refund via Credit Card (eWAY) をクリックします(ボタンには決済方法のタイトルが使われます)。全額返金と一部返金に対応しています。返金は決済が行われた環境(サンドボックスまたは本番)で送信されるため、その環境の API キーとパスワードが設定されている必要があります。eWAY が返金を拒否した場合、WooCommerce には eWAY のコードが表示され、返金は記録されません。返金に成功すると、eWAY の返金取引 ID とともに注文メモに追加されます。
MyeWAY で行われた返金は WooCommerce には同期されません。必要に応じて、eWAY の返金ボタンを使わずに WooCommerce で手動返金を作成してください。
ライセンスキー
本プラグインは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > eWAY の上部にあります。キーを License key に貼り付けて、Activate をクリックします。ブロックには、ライセンスの有効期限日や貴店のドメインなどのステータスが表示されます。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクから、vibefox.net のアカウントを開けます。
1 つのキーは 1 つのドメインでのみ有効です。あるサイトからキーを削除しても、そのドメインの枠は解放されません。枠は vibefox.net のアカウントで解放してください。
有効なキーがない場合、eWAY は購入者にチェックアウトで表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、決済方法が (unlicensed — visible to admins only) と表示された状態で引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインページと WooCommerce のページには、リマインダーが表示されます。既存の注文には影響しません。開始済みの決済は引き続き確認され、返金も行えます。
ライセンスの期限が切れても、プラグインは動作を続けますが、更新とサポートには更新が必要です。ステータスは、バックグラウンドで自動的に再確認されます。
トラブルシューティング
eWAY does not appear at checkout: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードの API キーとパスワードが設定されていること(サンドボックスモードではサンドボックスの項目、本番モードでは本番の項目)、ストア通貨が AUD、NZD、SGD、HKD、MYR のいずれかであることを確認してください。Pay for order ページでは、注文の通貨が確認されます。
The payment went through, but the order stays Pending payment: 購入者が eWAY から戻らなかったか、その時点で eWAY に問い合わせできませんでした。eWAY は Shared Page の通知を送信しません。決済は、「注文受付」ページを開いたときと、WooCommerce が未払い注文をキャンセルする前に、再確認されます。MyeWAY で取引を確認し、WooCommerce > Status > Logs(ソースは wcp_eway_payment_gateway)を確認してください。
購入者に This payment method is temporarily unavailable というメッセージが表示される: 現在のモードの API キーまたはパスワードが未入力か、eWAY がそれらを拒否しました。現在のモードの認証情報を確認してください。
購入者に eWAY could not start the payment というメッセージが表示される: eWAY がエラーコードを返しており、そのコードがメッセージに表示されています。多くの場合、請求情報が無効です。
購入者に We could not match this payment to an order というメッセージが表示される: 戻りリンクが、このストアのどの注文にも属していません。購入者に請求が発生している場合は、MyeWAY で決済を探してください。
購入者に We could not confirm your payment with eWAY というメッセージが表示される: 決済結果を確認できませんでした。結果を取得できた時点で注文は更新されます。購入者は再度支払う必要はありません。
Order is On hold after payment: 注文メモを確認してください。承認された金額または通貨が注文と異なっていたか、注文がキャンセルされた後に決済が届いています。注文を完了するか、決済を返金してください。
サンドボックスまたは本番モードに関するメッセージが表示されて返金に失敗する: 注文はその環境で支払われており、その環境の API キーとパスワードが設定されていません。入力してから、もう一度お試しください。
ライセンスブロックにエラーが表示される: ブロック内のメッセージに従ってください。例えば、キーが別のドメインで既に使われている場合は、vibefox.net のアカウントで枠を解放してから Check now をクリックします。サイトのアドレスを変更した場合は、Check now をクリックして、新しいドメインでキーを有効にします。ライセンスサーバーに接続できない場合、プラグインは最後に確認できたステータスで動作を続けます。
開発者向け: readme には、eWAY アカウントでさらに多くの通貨が有効になっている場合に使える eway_p_supported_currencies フィルターが記載されています。
アンインストール
プラグインを無効にしても、すべてのデータは保持されます。削除するには、Plugins ページでプラグインを無効化してから削除してください。本プラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定とログは、Uninstall(Delete all plugin data on uninstall)がオンだった場合にのみ削除されます。そうでない場合は、後日の再インストールのために残ります。注文に保存された決済参照情報は、常に保持されます。既存の注文は、決済メモと取引 ID を保持します。
eWAY は、各所有者の商標です。本プラグインは eWAY と提携しておらず、eWAY による推奨もされていません。
