VibeFox Autopay for PrestaShop — ヘルプ
要件
PrestaShop: 8.0 から 9.x。
PHP: 8.0 以降。モジュールは、それより古い PHP バージョンではインストールを拒否します。
Autopay サービス: Autopay サービスの Service ID と Shared key(ハッシュキー)が必要です。これらは Autopay の加盟店ポータルに表示されます。本番は portal.autopay.eu、テストは testportal.autopay.eu です。テストサービスには独自の Service ID と Shared key があります。Autopay に依頼して開設してもらってください。サービスのハッシュ関数は SHA-256 である必要があります。
通貨: カートの通貨は PLN、EUR、GBP、USD、CZK のいずれかで、お使いの Autopay サービスが受け付けるものである必要があります。
到達可能なストア: Autopay がストアに通知を送信できる必要があるため、ストアはベーシック認証なしで、かつ POST リクエストをブロックするファイアウォールなしでインターネットから到達可能でなければなりません。ストアのメンテナンスモードや国別の制限は、通知をブロックしません。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. 管理画面で Modules > Module Manager を開き、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧から VibeFox Autopay Payment を探し、Configure をクリックします。
3. Configure ページ上部のライセンスブロックの License key に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーの項を参照)。
4. Service ID と Shared key(テストと本番)を入力し、サービスの通貨を選択します。
5. Autopay のポータルで、サービスの ITN URL、戻り先 URL、SHA-256 ハッシュ関数を設定します(設定の項を参照)。
6. Enable/Disable をオンにして Save をクリックします。テストモードでテスト注文を行い、実際の支払いのために Test mode をオフにします。
インストール時、モジュールは注文ステータス Autopay payment on hold を作成します。PrestaShop は、新しい決済モジュールをすべての通貨、国、顧客グループに対して有効にします。Payment > Preferences で制限できます。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Autopay Payment > Configure。各セクションには独自の Save ボタンがあり、ページ全体が保存されます。フィールドの上では、選択した環境の Service ID や Shared key が空の場合、またはストアの既定の通貨が Currencies で選択されていない場合に、ページが警告します。どちらの場合も、支払い方法はチェックアウトで(選択されていない通貨について)非表示になります。
Autopay
Enable/Disable: Enable Autopay payment gateway は支払い方法をオンまたはオフにします。既定値: オフ。
Title: 購入者がチェックアウトで見る支払い方法の名前です。注文に保存される支払い方法の名前にもなります。既定値: Autopay。必須。
Description: チェックアウトで支払い方法の下に表示されるテキストです。既定値: Pay online by bank transfer, BLIK or card. You will be redirected to the secure Autopay payment page.
Autopay サービス
Service ID と Shared key は、Autopay の加盟店ポータルに表示されます(portal.autopay.eu または testportal.autopay.eu。このセクションにリンクがあります)。
Test mode: Autopay のテスト環境(testpay.autopay.eu)と、下記のテスト用認証情報を使用します。既定値: オン。オフにすると、本番用認証情報で pay.autopay.eu の実際の支払いを受け付けます。
Service ID (production): portal.autopay.eu にある数値のサービス ID です。
Shared key (production): 本番サービスのハッシュキーです。秘密にしてください。
Service ID (test): testportal.autopay.eu にある数値のサービス ID です。
Shared key (test): テストサービスのハッシュキーです。
保存時に、文字、数字、ハイフン、アンダースコア以外の文字を含む Service ID はエラーで拒否され、何も保存されません。保存済みの Shared key は再び表示されません。フィールドは空のままで、Saved — leave empty to keep it. と表示されます。変更したい場合にのみ新しい値を入力してください。
Clear saved keys: キーにチェックを入れて Save をクリックすると、削除されます。空のフィールドは保存済みの値を保持します。
Currencies: お使いの Autopay サービスが受け付ける通貨:PLN、EUR、GBP、USD、CZK。Autopay は通常、通貨ごとに個別のサービスを開設します。支払い方法は、カートの通貨がここで選択されている場合にのみ提供されます。既定値: PLN。
支払い通知(ITN)と戻り先アドレス
これらのアドレスを、本番用とテスト用の両方について、Autopay のポータルでサービスに入力してください。正確なアドレスは、このセクションの Addresses フィールドに表示されます。フレンドリー URL を使用している場合は、次のような形になります。言語コード(/en/ など)が付くこともあります。
アドレスは、設定に表示されているとおりに正確にコピーしてください。ITN URL がないと、PrestaShop は Autopay が支払いを確認した時点でのみ注文を作成するため、注文は一切作成されません。各 ITN は、通知で指定されたサービスの Shared key を使って作られた SHA-256 ハッシュで検証されます。有効なハッシュがない通知や、未知の Service ID の通知は拒否されます。通知がカートに適用されるのは、その支払いが同じ Autopay サービスで開始されている場合だけです。そのため、テスト通知が本番の支払いを確認することはありません。Test mode を切り替える前に開始された支払いの通知は、両方の認証情報が保存されている限り、引き続き正しいキーで検証されます。
モジュールは ITN で次の支払いステータスを処理します:
詳細設定
Logging: 支払いイベントを、モジュールフォルダ内の logs/wc_ap_debug.log.php に書き込みます。このファイルは Web からは開けません。キーや購入者データは記録されません。既定値: オフ。オフの間は、エラーを含めて何も書き込まれません。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると空になります。
チェックアウト
支払い手続きの段階で、購入者は支払い方法(既定では Autopay)とその説明を確認して選択します。次のページには Thank you. You are being redirected to Autopay to complete the payment. Your order is created as soon as Autopay confirms it. が表示され、購入者は Autopay の決済ページに送られます。購入者がブラウザの戻るボタンで戻った場合、ページは再度リダイレクトする代わりに Pay with Autopay ボタンを表示します。この時点ではまだ注文は存在しません。
モジュールは、カートの通貨でのカート合計額、注文の参照番号としてのカート番号、説明(Cart と番号)、購入者のメールアドレスを渡します。Autopay のページで、購入者は支払い方法を選んで支払います。
注文が支払い済みとマークされるのは、Autopay が署名付きの ITN で確認し、金額と通貨がカートと一致した後だけです。その後、注文が作成され、購入者は PrestaShop の標準の注文メールを受け取ります。支払い後、購入者はストアに戻ります。戻り先アドレスは署名されていますが、注文を作成することも変更することもありません。注文がすでに存在する場合、購入者には標準の注文確認ページが表示されます。ITN がまだ届いていない場合は、Payment confirmation ページに Thank you. Your payment is being confirmed by Autopay — your order will be created as soon as Autopay confirms it, and you will receive an e-mail. と、Check again と Back to checkout のボタンが表示されます。
Autopay が支払い失敗を報告した場合、購入者は The payment was not completed. You can try again or choose another payment method. とともにチェックアウトに戻ります。カートは保持されます。支払いを開始できない場合、購入者はチェックアウトに留まり、たとえば Autopay payments are not configured. Please choose another payment method or contact the store. のような短いメッセージ、または Autopay がその通貨での支払いを受け付けられないという内容が表示されます。
モジュールには、PrestaShop からの返金、サブスクリプションや定期払い、カードの保存、チェックアウトページの BLIK コードやカードフォーム、チェックアウトページでの銀行や決済チャネルの選択はありません。また、環境ごとに 1 つの Service ID を使用します。
注文
注文ステータス
No order yet: 購入者は Autopay に送られたものの、支払っていない、支払いが失敗した、または Autopay がまだ支払いを確認していない状態です。存在するのはカートだけです。
Payment accepted: Autopay が支払いを確認し、金額と通貨が一致しています。支払いは Autopay の取引 ID(remoteID)を取引 ID として記録され、メモには金額、Autopay の取引、支払日が表示されます。
Autopay payment on hold: Autopay がカート合計と異なる金額または通貨を報告しました(たとえば、支払い開始後にカートが変更された場合)。注文は支払い済みになりません。Autopay のポータルで取引を確認し、手動で完了するか返金してください。その注文について後から正しい通知が届くと、支払い済みになります。同じステータスは、キャンセル済みの注文に支払いが届いた場合にも使われます。その場合、支払いは記録され、メモで在庫を確認して注文を処理するか、支払いを返金するよう求められます。
支払い済みの注文が、後から届いた失敗通知によって変更されることはありません。Autopay が支払い済みの注文について別の成功した支払いを報告した場合、メモで購入者が二重に支払った可能性があることが警告されます。別の Autopay サービスで開始された支払いの通知は適用されず、その理由がメモに記されます。メモはスタッフだけに表示され、注文ページの Autopay payment ブロックにあります。
Autopay payment ブロック
注文ページには Autopay payment ブロックが表示されます。内容は、Autopay OrderID、Service ID と環境、金額と通貨、支払いステータス、Autopay 取引 ID、テスト支払い用の Test mode バッジ、注文の Autopay notes です。このブロックは読み取り専用です。
返金
Autopay を通じた返金はサポートされていません。Autopay のポータルで支払いを返金し、その後、標準の注文ツールで PrestaShop に記録してください。
ライセンスキー
このモジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Autopay Payment は Modules > Module Manager > VibeFox Autopay Payment > Configure の一番上にあるブロックで、設定の上に表示されます。キーを License key に入力し、Activate をクリックします。その後、ブロックにはキーが伏せ字で表示され、ステータス(ライセンスの有効期限日やドメインなど)と、ボタン Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)が表示されます。その下には Product: presta-payment-autopay の行と、vibefox.net のアカウントを開く Manage licenses and domains in your account のリンクがあります。キーを変更できるのは、このモジュールの Configure 権限を持つ従業員だけです。ブロックのテキストはバックオフィスの言語に従います(英語とロシア語を含みます)。
キーが受け付けられない場合、ブロックは理由を表示します。たとえば Key not found、This key belongs to another product、Domain limit reached、License expired on(日付付き)です。ショップのアドレスを変更した後、またはアカウントでドメインの枠を解放した後に、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認された状態で動作を続けます。
1 つのキーは 1 つのドメインでのみ使用できます。メインショップのドメインで、マルチストア構成の場合も同様です。ショップからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、チェックアウトで購入者には Autopay が表示されません。それでも支払いが開始されると、購入者には This payment method is not available. Please choose another one. と表示されます。PrestaShop のストアフロントはバックオフィスにログインしていることを認識しないため、支払い方法はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。すでに開始された支払いは引き続き確認されます。
ライセンスが期限切れになると、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Autopay が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、選択した環境に Service ID と Shared key があること、そしてカートの通貨が Currencies で選択されていることを確認してください。いずれかが欠けている場合、設定ページに警告が表示されます。Payment > Preferences で、カートの通貨、購入者の国、購入者のグループに対してモジュールが許可されているかを確認してください。
支払いは完了したが、注文が作成されなかった: Autopay が ITN を配信しなかったか、ストアがそれを拒否しました。設定に表示されている ITN URL が、Autopay のポータルでそのサービス(本番またはテスト)に設定されていること、ハッシュ関数が SHA-256 であること、モジュールの Shared key がサービスと一致していることを確認してください。ストアがインターネットから到達可能かも確認してください。Logging をオンにして、モジュールのページの Log フィールドを確認してください。
ログに ITN rejected: invalid hash と表示される: Shared key がサービスと一致しないか、サービスのハッシュ関数が SHA-256 ではありません。
ログに、service ID が設定されていないと表示される: 通知は、Service ID がモジュールに入力されていないサービス、または Shared key が空のサービスから届きました。
ログに could not lock the cart, Autopay will retry と表示される: そのカートは同じ瞬間に別の通知によって処理中でした。ストアは、Autopay が通知を再送するように応答します。モジュールが無効になっているなどの理由で注文を作成できなかった場合も、同じことが起こります。
注文が Autopay payment on hold になり、不一致のメモがある: Autopay がカート合計と異なる金額または通貨を報告しました。Autopay のポータルで取引を確認し、注文を手動で完了するか返金してください。
メモに、通知が適用されなかった(NOT applied)と表示される: この注文の支払いは、この Autopay サービスで開始されたものではありません。たとえば、実際の注文に対してテスト通知が届いた場合です。Autopay のポータルで取引を確認してください。
支払い後、購入者がホームページに移動する: 戻り先アドレスを検証できませんでした。たとえば、Service ID がモジュールに入力されていない場合です。注文は影響を受けず、ITN に従います。
購入者に This payment method is not available. と表示される: このカートでは支払い方法が提供されていません(無効、認証情報がない、通貨が選択されていない、または Payment > Preferences で許可されていない)。
アンインストール
Modules > Module Manager に移動し、VibeFox Autopay Payment の横にあるメニューを開いて Uninstall を選びます。このモジュールのライセンスキーとライセンスステータスは、常に削除されます。キーを含むモジュールの設定と、ログが削除されます。モジュールには、設定を保持するオプションはありません。Autopay の支払い記録と、注文ステータス Autopay payment on hold は常に保持されます。既存の注文は、支払いのメモと取引 ID を保持します。
Autopay は、それぞれの所有者の商標です。このモジュールは Autopay と提携しておらず、Autopay の承認も受けていません。
