VibeFox MultiSafepay for PrestaShop — ヘルプ
要件
PrestaShop: 8.0 から 9.x まで。
PHP: 8.0 以降。モジュールは、それより古い PHP バージョンではインストールできません。
通貨: カートの通貨は MultiSafepay が受け付ける通貨である必要があります(例: EUR、USD、GBP、PLN、CHF、SEK、DKK、NOK)。その他の通貨の場合、チェックアウト時にこの決済方法は表示されません。
MultiSafepay アカウント: MultiSafepay Control で貴サイトの API キーを取得しておく必要があります。テスト用アカウントと本番用アカウントではキーが異なります。MultiSafepay 側で他に設定する必要はありません。通知先アドレスはすべての決済に含まれます。
公開サイト: MultiSafepay が通知を送信するためにストアにアクセスできる必要があります。アクセスできない場合でも、購入者が MultiSafepay から戻ってきた時点で注文は作成されます。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。
インストール
1. 管理画面で Modules > Module Manager を開き、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。または、後でモジュール一覧から VibeFox MultiSafepay Gateway を探して Configure をクリックします。
3. Configure ページ上部のライセンスブロックにある License key 欄に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。
4. MultiSafepay Control から取得したテスト用および/または本番用の API キーを貼り付けます(設定を参照)。
5. Enable/Disable を有効にして Save をクリックします。Test mode を有効にした状態で決済をテストし、その後、実際の支払いを受け付けるために無効にします。
インストール時に、モジュールは注文ステータス MultiSafepay payment on hold を作成します。PrestaShop は、すべての通貨、国、顧客グループに対して新しい決済モジュールを提供します。Payment > Preferences でこれらを制限できます。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox MultiSafepay Gateway > Configure。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。フィールドの上には、テストモードが有効な間 Test mode: new payments use the MultiSafepay test environment (no real payments). と表示され、現在のモードに API キーがない場合(その決済方法はチェックアウトに表示されません)や、MultiSafepay が貴店の既定の通貨を受け付けない場合に警告が表示されます。Title がない場合、ページは保存されません。
チェックアウト
Enable/Disable: Enable MultiSafepay で決済方法を有効または無効にします。既定値: 無効。
Title: チェックアウト時に購入者に表示される決済方法名です。注文にも、この名前が決済方法として保存されます。既定値: MultiSafepay。必須。
Description: チェックアウト時に決済方法の下に表示されるテキストです。既定値: Pay securely with iDEAL, cards, Bancontact, PayPal and more via MultiSafepay.
API キー
API キーは MultiSafepay Control > Manage settings > Website settings にあります。このセクションには、テスト用アカウント(testmerchant.multisafepay.com)と本番用アカウント(merchant.multisafepay.com)へのリンクがあります。両者のキーは異なります。テストモードではテスト用キーのみ、本番モードでは本番用キーのみを使用します。
Test mode: Use the MultiSafepay test environment (no real payments). API アドレスと API キーの両方を切り替えます。すでに行われた決済は、ステータス確認と返金に、その決済が行われた環境を引き続き使用します。既定値: 有効。有効な間、購入者には決済方法の下に Test mode: no real payment will be made. と表示されます。
Test API key: MultiSafepay テスト用アカウントの API キーです。
Live API key: MultiSafepay 本番用アカウントの API キーです。
保存されたキーは再表示されません。フィールドは空のままで、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
Clear saved keys: キーにチェックを入れて Save をクリックすると削除されます。フィールドが空の場合は、保存されている値が維持されます。
通知
設定は不要です。Notification URL フィールドには、すべての決済とともに MultiSafepay に送信されるアドレスが表示されます。フレンドリー URL を使用している場合は、https://your-shop/module/wcp_multisafepay_gateway/webhook のような形式になり、/en/ などの言語コードが付くこともあります。通知はどの決済が変更されたかをモジュールに伝えるだけです。ステータス、金額、通貨は、注文の作成または変更の前に、常に貴店の API キーを使って MultiSafepay API から読み取られます。貴店で開始されていない決済の通知は無視されます。通知は、ショップがメンテナンスモードの間も機能し、ショップの国別制限によってブロックされることもありません。
注文
Order status after payment: 支払い済み注文のステータスです。ステータスは一度に設定され、ステータス変更は 1 回、購入者へのメールも 1 通のみ送信されます。
詳細設定
Debug log: Log API calls and notifications を有効にすると、モジュールフォルダー内の logs/mspg_debug.log.php に記録されます。このファイルは Web から開くことはできません。エラーと警告は常に記録されます。API キーと顧客データは決して記録されません。既定値: 無効。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックするとログが空になります。
Delete data on uninstall: 有効にすると、モジュールのアンインストール時に設定とログが削除されます。注文の MultiSafepay 決済データと注文ステータスは常に残るため、古い注文の返金は引き続き可能です。モジュールを無効にしても、何も削除されません。既定値: 無効。
チェックアウト
決済の段階で、購入者は決済方法(既定では MultiSafepay のロゴが付いた MultiSafepay)を選択して確定します。モジュールは、カートの通貨でカートの合計金額に対する MultiSafepay の決済を作成し、購入者を MultiSafepay の決済ページに移動させます。そこで購入者は、貴店の MultiSafepay アカウントで有効になっている任意の決済方法を選んで支払います。購入者の請求先住所、メールアドレス、電話番号、言語が MultiSafepay に渡され、決済は Order #、カート番号、貴店の名称とともに表示されます。この時点ではまだ注文は存在しません。
支払い後、購入者は貴店に戻ります。注文は、MultiSafepay が確認した後にのみ支払い済みとしてマークされます。確認は通知によるか、購入者が戻ってきた際の MultiSafepay API への問い合わせによって行われます。その後注文が作成され、購入者には標準の注文確認ページが表示され、Your payment with MultiSafepay has been received. と表示されます。保留中の注文の場合、ページには We are confirming your payment with MultiSafepay. The order will be updated automatically — please do not pay again. と表示されます。その後決済が失敗した場合、ページには Your MultiSafepay payment was not completed. Please contact us about this order. と表示されます。購入者が戻った時点で MultiSafepay がまだ決済を確認していない場合(例: 銀行振込を待っている場合)、Payment confirmation ページに同じ確認メッセージと Check again ボタンが表示されます。通知は、MultiSafepay が決済を報告した時点で注文を作成します。
購入者が MultiSafepay のページでキャンセルした場合、または決済が拒否されたり期限切れになったりした場合、購入者はカートを保持したままチェックアウトに戻り、次のいずれかのメッセージが表示されます:The MultiSafepay payment was cancelled. You can try again or choose another payment method.、The payment was declined. Please try again or choose another payment method.、または The payment session has expired. Please try again.
同じカートの新しい決済を作成する前に、モジュールは MultiSafepay で前回の決済を確認します。すでに支払い済みであるか処理中の場合は、新しい決済ではなく注文が作成されます。金額が同じままで未完了の場合は、同じ決済ページが再利用されます。金額が変わった場合は、古い決済が MultiSafepay でキャンセルされ、支払いできなくなります。
MultiSafepay が決済を開始できない場合、購入者はチェックアウトに留まり、例えば Could not connect to MultiSafepay. Please try again in a moment. や MultiSafepay cannot accept this order amount or currency. Please choose another payment method. といった短いメッセージが表示されます。技術的な理由はログに記録されます。
モジュールが提供する決済方法は 1 つだけで、MultiSafepay の決済ページに移動します。MultiSafepay の決済方法ごとに別々の PrestaShop 決済方法はなく、カード入力欄の埋め込み、Apple Pay や Google Pay のエクスプレスボタン、サブスクリプション、定期払い、保存済みカードもありません。PrestaShop からキャプチャや取消を行うこともできません。カート情報は送信されないため、それを必要とする後払い方法(例: Klarna、in3、Riverty)は、これらの注文では MultiSafepay によって提供されません。
注文と返金
注文ステータス
まだ注文はありません: 購入者は MultiSafepay に移動しましたが、まだ支払っていないか、MultiSafepay がまだ決済を確認していません。存在するのはカートだけです。
Payment accepted または Delivered: MultiSafepay が決済を確認しました(完了または発送済み)。ステータスは Order status after payment に従います。決済は、MultiSafepay の注文 ID をトランザクション ID として記録され、メモには決済、決済方法、環境が表示されます。
MultiSafepay payment on hold before payment: 決済が未清算(MultiSafepay による審査中)または承認済み(オーソリ済み)です。お金を受け取るには、MultiSafepay Control で承認済みの決済をキャプチャしてください。MultiSafepay が完了として報告すると、注文は自動的に支払い済みのステータスに移ります。
MultiSafepay payment on hold after payment: MultiSafepay が、カートの合計と異なる金額または通貨を確認しました(例: 決済の開始後にカートが変更された)。モジュールがライブモードの間にテスト決済が完了しました(実際のお金は受け取っておらず、決済は記録されません)。または、注文がキャンセルされた後に決済が完了しました。メモにその理由が説明されます。MultiSafepay Control でトランザクションを確認し、注文を処理するか返金してください。
MultiSafepay payment on hold after a chargeback: 支払い済みの注文について、MultiSafepay からチャージバックが報告されました。お金は貴店の口座から差し戻されました。
Payment error: 未清算または承認済みの決済が、その後拒否、キャンセル、期限切れ、またはボイドになりました。
Refunded: モジュールを通じて、決済の全額が返金されました。
支払い済みまたは返金済みの注文が、遅れて届いた通知によって再度開かれることはありません。すでに支払い済みのカートに対して 2 回目の決済が完了しても、注文は変更されません。メモには、MultiSafepay Control で重複分を返金するよう指示が表示されます。
MultiSafepay 決済ブロック
注文ページには MultiSafepay payment ブロックが表示され、MultiSafepay の注文 ID、決済方法、ステータス、支払い済み金額と返金済み金額、テスト決済用の Test mode バッジ、返金履歴、注文の MultiSafepay notes が含まれます。
返金
MultiSafepay payment ブロックで金額を入力し(まだ返金されていない金額が自動入力されます)、必要に応じて理由を入力して、Refund via MultiSafepay をクリックします。確認の質問 Refund this amount through MultiSafepay? This cannot be undone. に同意してください。全額返金と一部返金に対応しています。注文を編集する権限が必要です。モジュールのページへのアクセスは必要ありません。返金は、MultiSafepay が請求した金額と通貨で行われます。そのため、金額に不一致がある場合は、注文の合計ではなく、購入者が実際に支払った金額まで返金できます。返金は決済が行われた環境(テストまたは本番)に送信されるため、その環境の API キーが設定されている必要があります。MultiSafepay が返金を受け付けない場合、ブロックには MultiSafepay refund failed: と MultiSafepay のエラーが表示され、返金は記録されません。返金が成功すると、MultiSafepay の返金 ID とともに返金履歴とメモに追加されます。全額返金を行うと注文は Refunded になります。一部返金ではステータスは変わりません。返金は、MultiSafepay が決済を報告した後に利用できます。
モジュールはクレジットスリップを作成しません。注文ページの標準の PrestaShop の返金ボタンでは、MultiSafepay を通じて返金されることはありません。
MultiSafepay Control で行われた返金は、MultiSafepay が報告すると、メモに追加されます。注文ステータスやクレジットスリップは自動的に変更されません。必要に応じて手動で更新してください。
ライセンスキー
このモジュールは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox MultiSafepay Gateway は、Modules > Module Manager > VibeFox MultiSafepay Gateway > Configure の最初のブロックで、設定の上に表示されます。キーを License key に入力し、Activate をクリックしてください。その後、ブロックにはキーがマスクされた状態、ステータス(例: ライセンスの有効期限日と貴ドメイン)、ステータスを再確認するための Check now、別のキーを入力するための Change key、このストアからキーを削除するための Remove key のボタンが表示されます。その下には Product: presta-payment-multisafepay の行と、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 のアカウントで枠を解放してください。
有効なキーがない場合、チェックアウト時に MultiSafepay は購入者に表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。PrestaShop のストアフロントは、バックオフィスにログインしていることを認識しないため、その決済方法は貴方にも非表示になります。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文は影響を受けません。すでに開始された決済は引き続き確認され、返金も機能します。
ライセンスが期限切れになっても、モジュールは動作し続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日に 1 回、その後は週に 1 回です。cron ジョブは必要ありません。モジュールのアンインストールまたはリセットを行うと、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに MultiSafepay が表示されない: ライセンスが有効であること、Enable/Disable が有効であること、現在のモードに API キーがあること(テストモードでは Test API key、本番モードでは Live API key)、そしてカートの通貨が MultiSafepay で受け付けられることを確認してください。キーがない場合やショップの通貨が受け付けられない場合、設定ページに警告が表示されます。Payment > Preferences で、カートの通貨、購入者の国、購入者のグループに対してモジュールが許可されているか確認してください。
決済は完了したが、注文が作成されていない: 通知が貴店に届きませんでした。貴店がインターネットからアクセス可能であること、決済の環境の API キーが設定されていることを確認してください。モジュールは MultiSafepay API からステータスを読み取るためです。API にアクセスできない場合やキーがない場合、通知は ERROR と応答し、MultiSafepay は再試行します。注文は、購入者がストアに戻ったときや、同じカートを再度支払おうとしたときにも作成されます。
通知が Invalid request と応答する: リクエストに有効なトランザクション ID がありませんでした。MultiSafepay からの通知には、必ずトランザクション ID が含まれています。
購入者が MultiSafepay を選択するとエラーが表示される: Debug log を有効にし、モジュールページの Log フィールドを確認してください。This payment method is temporarily unavailable. Please choose another payment method. は、通常、API キーの誤りまたは欠落を意味します。MultiSafepay cannot accept this order amount or currency. Please choose another payment method. は、MultiSafepay が金額または通貨を拒否したことを意味します。
注文が MultiSafepay payment on hold になっている: MultiSafepay payment ブロックのメモを確認してください。決済が未清算または承認済みである、支払い済みの金額または通貨がカートと異なる、ライブモードでテスト決済が届いた、注文のキャンセル後に決済が届いた、またはチャージバックがあった、といった可能性があります。MultiSafepay Control でトランザクションを確認してください。
テスト決済ではライブの注文は確定しない: モジュールがライブモードの間、テスト決済で注文が支払われることはありません。代わりに注文が保留になります。ライブに切り替えた後も、以前のテスト決済はテスト用キーで引き続き確認・返金されます。
返金が環境に関するメッセージで失敗する: 決済はテスト環境または本番環境で行われており、その環境の API キーが設定されていません。キーを入力して、もう一度お試しください。
アンインストール
Modules > Module Manager に移動し、VibeFox MultiSafepay Gateway の横にあるメニューを開いて、Uninstall を選択します。このモジュールのライセンスキーとライセンスステータスは常に削除されます。Delete data on uninstall が有効な場合、設定とログは削除されます。無効な場合、すべての設定は、後で再インストールするために保持されます。注文の MultiSafepay 決済データと注文ステータス MultiSafepay payment on hold は常に保持されるため、以前に支払われた注文は、再インストール後も返金できます。既存の注文は、決済メモとトランザクション ID を保持します。
MultiSafepay は、各所有者の商標です。本モジュールは MultiSafepay と提携しておらず、MultiSafepay による推奨も受けていません。
