VibeFox eWAY for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 ～ 9.x。

PHP: 8.0 以降。古いバージョンの PHP では、モジュールのインストールは拒否されます。

ショップ通貨: AUD、NZD、SGD、HKD、MYR のいずれか。それ以外のカート通貨では、チェックアウト時にこの支払い方法は表示されません。支払いはカートの通貨で請求されます。

eWAY アカウント: Rapid API へのアクセス権を持つ eWAY 加盟店アカウントと、その Rapid API キーおよびパスワードが必要です。これらは MyeWAY の Settings, API Key から取得できます。テストには、専用のキーとパスワードを持つ eWAY サンドボックスアカウントが必要です。サンドボックス用とライブ用のキーは別々です。eWAY 側で設定する必要はありません。返却 URL は、すべての支払いに付随して送信されます。

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

インストール

1. 管理画面で Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択してください。

2. アップロードが完了したら Configure をクリックします。後で確認する場合は、モジュール一覧から VibeFox eWAY Payment Gateway を探して Configure をクリックしてください。

3. Configure ページ上部のライセンスブロックで License key に VibeFox ライセンスキーを入力し、Activate をクリックしてください（「ライセンスキー」を参照）。

4. サンドボックスの API キーとパスワードを入力し、Sandbox Mode をオンのままにして、Enable/Disable をオンにしてから、Save をクリックし、テスト注文を行ってください。

5. ライブの API キーとパスワードを入力し、Sandbox Mode をオフにして、Save をクリックしてください。

6. 必要に応じて、Configure ページに表示される cron URL をサーバーの cron ジョブに追加してください（設定の項を参照）。

インストール時にモジュールは注文ステータス eWAY payment on hold を作成します。PrestaShop は、すべての通貨、国、顧客グループを対象とした新しい支払いモジュールを提供します。これらは Payment > Preferences で制限できます。

設定

すべての設定はモジュールのページにあります：Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。項目の上には、現在のモードを示すバッジが表示されます：SANDBOX — payments go to the eWAY sandbox, no real money is charged. または LIVE — real payments are taken with the live API key. 現在のモードの API キーまたはパスワードが未入力の場合（この場合、チェックアウトで支払い方法は表示されません）や、ショップのデフォルト通貨が eWAY でサポートされていない場合には、ページに警告が表示されます。

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: 支払いは、サンドボックス用のキーとパスワードを使って eWAY のサンドボックスに送られます。実際の料金は請求されません。デフォルト：オン。ライブ用のキーで実際の支払いを受け付けるには、オフにしてください。オンの間、お客様には支払い方法の下に Test mode: no real payment is taken. と表示されます。

Live API Key: eWAY のライブアカウントの Rapid API キーです。

Live API Password: eWAY のライブアカウントの Rapid API パスワードです。

Sandbox API Key: eWAY サンドボックス（パートナー／開発者）アカウントの Rapid API キーです。

Sandbox API Password: eWAY サンドボックスアカウントの Rapid API パスワードです。

保存されたキーとパスワードは、再度表示されることはありません。入力欄は空のままで、Saved — leave empty to keep it. と表示されます。値を変更する場合にのみ、新しい値を入力してください。

Clear saved credentials: キーまたはパスワードにチェックを入れて Save をクリックすると、削除されます。入力欄が空の場合は、保存されている値が維持されます。

Return URL / re-checks: eWAY で webhook や返却 URL を設定する必要はありません。返却 URL は、すべての支払いに付随して送信されるためです。この項目には、任意の cron URL が表示されます。サーバーの cron ジョブ（例：15 分ごと）から呼び出してください。お客様が支払い後、ショップに戻る前にブラウザを閉じた場合、約 1 時間後に eWAY へ支払いが問い合わせられ、注文が作成されます。eWAY に接続できない場合、確認は最大 3 回まで繰り返されます。この URL は秘密にしてください。トークンが含まれており、誤ったトークンでの呼び出しには Forbidden が返されます。

注文

Order Status on Success: eWAY が支払いを確認した後の注文ステータスです。

注文と一致しない承認金額または通貨は、常に eWAY payment on hold になります。

詳細設定

Debug log: API の呼び出しと支払い結果を、モジュールフォルダー内の logs/eway_p_debug.log.php に書き込みます。このファイルはウェブから開くことはできません。カード情報、キー、パスワード、お客様のメールアドレス、アクセスコードは記録されません。エラーは常に記録されます。デフォルト：オフ。

Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログを空にできます。

Delete all plugin data on uninstall: オンにすると、モジュールのアンインストール時にゲートウェイの設定とログが削除されます。注文の eWAY 支払いデータと、注文ステータス eWAY payment on hold は常に残ります。デフォルト：オフ。

チェックアウト

支払い手続きのステップで、お客様は支払い方法（デフォルトは Credit Card (eWAY)）を選び、確定します。モジュールは、カートの通貨でカート合計額の決済ページを eWAY に要求します。その際、請求書の参照番号として PS- とカート番号、さらにお客様の請求先住所とメールアドレスを添えて、お客様を eWAY Responsive Shared Page に移動させます。お客様はそのページでカード支払いを行います。料金は直ちに請求されます。この時点では、まだ注文は存在しません。

支払い後、お客様はショップに戻ります。モジュールはブラウザを信用しません。このカートのために作成された決済ページの結果を、サーバー間通信で eWAY に問い合わせます。注文が支払い済みとしてマークされるのは、eWAY が確認し、承認された金額と通貨がカートと一致した後のみです。その後、注文が作成され、お客様には標準の注文確認ページが表示されます。そこには Your payment with eWAY has been received. と表示されます。保留中の注文の場合、ページには Your payment was received and is being reviewed by the store. We will contact you if anything is needed. と表示されます。

その時点で eWAY に問い合わせられない場合、Payment confirmation ページに 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. と表示され、Check again ボタンと Back to checkout ボタンが表示されます。注文は、お客様が再確認したとき、または cron URL が実行されたときに作成されます。

支払いが拒否された場合、お客様は理由とともにチェックアウトに戻ります。たとえば Your payment was declined: D4451 Insufficient funds. Please try again or use a different payment method. と表示されます。お客様が eWAY のページで Cancel をクリックした場合、モジュールはまず eWAY に、何も支払われていないことを確認します（別のタブで支払われた場合などを含む）。その後、お客様には 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 で確認されます。すでに支払い済みであれば、二重に支払いを行うのではなく、注文が作成されます。eWAY が決済ページを作成できない場合、お客様はチェックアウトに留まり、Payment error: Unable to connect to eWAY. Please try again. や eWAY could not start the payment などの短いメッセージと、eWAY のエラーコードが表示されます。

Shared Page については、eWAY はサーバー間通信の通知を送信しません。結果は、お客様が戻ったときと cron URL によって取得されます。モジュールは、お使いのサイトにカード入力欄を持たず、カードの保存やサブスクリプションにも、承認のみや売上確定にも対応していません。また、Beagle の不正利用スコアは評価しません（eWAY の不正利用ルールによってブロックされた取引は、eWAY 自体によって拒否されます）。

注文と返金

注文ステータス

No order yet: お客様は eWAY に移動しましたが、まだ支払っていない、キャンセルした、支払いが拒否された、または結果をまだ取得できない状態です。カートのみが存在します。

Payment accepted or Delivered: 支払いが承認されました。ステータスは Order Status on Success に従います。支払いは eWAY のトランザクション ID とともに記録され、メモにはトランザクション ID、承認コード、レスポンス、モード（サンドボックスまたはライブ）が表示されます。

eWAY payment on hold: eWAY が、カートとは異なる金額または通貨を承認した場合（例：Approved for partial amount、またはお客様が決済ページを開いた後にカートが変更された場合）、お客様が eWAY のページでキャンセルした後に支払いが承認された場合、または注文がキャンセルされた後に支払いが承認された場合です。支払いは eWAY が実際に請求した金額で記録され、メモにその理由が説明されます。注文を確認して処理するか、支払いを返金してください。

Refunded: モジュールを通じて支払いが全額返金されました。

すでに支払い済みのカートに対して 2 回目の支払いが承認された場合、注文は変更されません。メモには、MyeWAY で重複分を返金するよう指示が表示されます。別の請求書参照番号に対して承認された支払いが、この注文に適用されることはありません。

eWAY 支払いブロック

注文ページには eWAY payment ブロックが表示され、トランザクション ID、承認コード、eWAY のレスポンス、ステータス、モード、請求書参照番号、支払い済み金額と返金済み金額、サンドボックス支払い用の Sandbox バッジ、返金履歴、注文の eWAY notes が含まれます。

返金

eWAY payment ブロックで金額を入力します（まだ返金されていない金額が自動入力されます）。必要に応じて理由を入力し、Refund via eWAY をクリックしてください。確認の質問 Refund this amount through eWAY? This cannot be undone. に対して承認してください。全額返金と一部返金に対応しています。注文を編集する権限が必要です。Modules のページにアクセスする権限は必要ありません。返金は、eWAY が請求した金額と通貨で行われます。そのため、一部金額での承認後は、注文の合計額ではなく、お客様が実際に支払った金額まで返金できます。返金は、支払いが行われた環境（サンドボックスまたはライブ）で送信されるため、その環境の API キーとパスワードが設定されている必要があります。eWAY が返金を拒否した場合、ブロックには eWAY のコードとともに eWAY refund failed: と表示され、返金は記録されません。返金が成功すると、返金履歴とメモに eWAY の返金トランザクション ID が追加されます。全額返金を行うと、注文は Refunded になります。一部返金ではステータスは変わりません。返金は、eWAY が支払いを承認した後に利用できます。

モジュールはクレジットスリップを作成しません。注文ページにある PrestaShop の標準の返金ボタンでは、eWAY を通じて返金されません。MyeWAY で行われた返金は、PrestaShop に同期されません。必要に応じて、注文を手動で更新してください。

ライセンスキー

このモジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスのブロック License — VibeFox eWAY Payment Gateway は、Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure ページで設定の上に表示される最初のブロックです。キーを License key に貼り付けて、Activate をクリックします。その後、ブロックにはキーがマスクされた状態で、ステータス（ライセンスの有効期限日やドメインなど）と、Check now（ステータスを再確認）、Change key（別のキーを入力）、Remove key（このストアからキーを削除）のボタンが表示されます。その下には Product: presta-payment-eway の行と、Manage licenses and domains in your account のリンクがあり、これは vibefox.net のアカウントを開きます。キーを変更できるのは、このモジュールの Configure 権限を持つ従業員だけです。ブロックのテキストはバックオフィスの言語に従います（英語とロシア語が含まれます）。

キーが受け付けられない場合、ブロックにその理由が表示されます。たとえば Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on などです。ショップのアドレスを変更した後や、アカウントでドメイン枠を解放した後には、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認されたステータスで動作を続けます。

1 つのキーは 1 つのドメインでのみ使用できます。メインショップのドメインであり、マルチストア構成でも同様です。ショップからキーを削除しても、ドメイン枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで購入者に eWAY は表示されません。それでも決済が開始された場合、購入者には この決済方法は利用できません。別の方法をお選びください。 と表示されます。PrestaShop のストアフロントは、バックオフィスにログインしていることを認識しないため、決済方法はお客様にも非表示になります。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブに通知が表示されます。既存の注文には影響しません。すでに開始された決済は引き続き確認され、返金も機能します。

ライセンスの期限が切れても、モジュールは動作し続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キーの入力後の最初の 14 日間は 1 日に 1 回、その後は週に 1 回です。cron ジョブは必要ありません。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

eWAY does not appear at checkout: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードの API キーとパスワードが設定されていること（サンドボックスモードではサンドボックスの項目、ライブモードではライブの項目）、そしてカート通貨が AUD、NZD、SGD、HKD、MYR のいずれかであることを確認してください。認証情報が未入力の場合、設定ページに警告が表示されます。Payment > Preferences で、カート通貨、お客様の国、お客様のグループに対してモジュールが許可されているかを確認してください。

The payment went through, but no order was created: お客様が eWAY から戻らなかったか、その時点で eWAY に問い合わせできませんでした。eWAY は Shared Page の通知を送信しません。Return URL / re-checks の cron URL を設定してください。これにより、約 1 時間後に支払いが取得されます。MyeWAY でトランザクションを確認し、モジュールのページにある Log 項目を見てください。

The customer sees This payment method is temporarily unavailable: 現在のモードの API キーまたはパスワードが未入力か、eWAY によって拒否されました。現在のモードの認証情報を確認してください。

The customer sees eWAY could not start the payment: eWAY がエラーコードを返しました。コードはメッセージに表示されます。多くの場合、請求情報が無効です。

The customer sees We could not match this payment to an order: 返却リンクがこのショップのカートに属していないか、eWAY が別の請求書参照番号に対する支払いを承認しました。お客様が請求された場合は、MyeWAY で支払いを探してください。

The customer sees We could not check the status of your previous payment attempt: 同じカートを別のリクエストが処理していました。お客様はしばらくしてから再試行できます。

Order is eWAY payment on hold after payment: eWAY payment ブロックの eWAY notes を読み（注文ステータスの項を参照）、注文を処理するか、支払いを返金してください。

Refund fails with a message about the sandbox or live mode: 注文はその環境で支払われましたが、その環境の API キーとパスワードが設定されていません。入力してから、もう一度お試しください。

Refund fails with at most … can be refunded: 金額が、eWAY が請求した金額から既存の返金額を差し引いた額を超えています。

開発者向け：モジュールの README には、フック actionWcpEwaySupportedCurrencies が記載されています。eWAY アカウントで追加の通貨が有効になっている場合に使用してください。

アンインストール

Modules > Module Manager に移動し、VibeFox eWAY Payment Gateway の横にあるメニューを開いて、Uninstall を選択してください。このモジュールのライセンスキーとライセンスステータスは常に削除されます。Delete all plugin data on uninstall がオンの場合は、ゲートウェイの設定とログが削除されます。オフの場合は、後で再インストールできるように、すべての設定が保持されます。注文の eWAY 支払いデータと、注文ステータス eWAY payment on hold は常に保持されるため、以前に支払われた注文は、再インストール後も返金できます。既存の注文は、支払いメモとトランザクション ID を保持します。

eWAY は、その所有者の商標です。このモジュールは eWAY と提携しておらず、eWAY による推奨も受けていません。