VibeFox CorvusPay for OpenCart — ヘルプ
要件
OpenCart: 3.0.x(3.0.5.0 で動作確認済み)または 4.0.2 以降(4.1.0.3 で動作確認済み)。
PHP: 8.0 以降。
通貨: AUD、BAM、BHD、CAD、CHF、CZK、DKK、EUR、GBP、HRK、HUF、ISK、MKD、NOK、PLN、RON、RSD、RUB、SEK、USD のいずれかです。チェックアウトの通貨がそれ以外の場合、支払い方法はチェックアウトで非表示になります。金額は小数点以下 2 桁で送信されます。小数点以下の桁数がそれより多い合計金額(たとえば BHD のような小数点以下 3 桁の通貨)は、四捨五入されず拒否されます。
CorvusPay アカウント: CorvusPay の加盟店アカウントが必要です。CorvusPay は、店舗ごとに Store ID と Secret Key を発行します。テスト店舗と本番店舗で別々に発行され、CorvusPay Merchant Center に表示されます。拡張機能の Success URL と Cancel URL は、そこに入力する必要があります(Configuration を参照)。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
ダウンロードは 1 つの zip ファイルで、両方の OpenCart バージョン用のパッケージが含まれています。コンピュータで解凍してください。README.txt、OpenCart 3 用のパッケージ wcp_corvuspay_gateway-oc3-(version).ocmod.zip、OpenCart 4 用のパッケージ wcp_corvuspay_gateway.ocmod.zip が含まれています。お使いの OpenCart バージョンのパッケージだけをインストールしてください。ライセンスキーは両バージョンで同じです。
OpenCart 3
1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル wcp_corvuspay_gateway-oc3-(version).ocmod.zip を選択します。この拡張機能には OCMOD による変更がないため、Extensions > Modifications を更新する必要はありません。インストーラーを使う代わりに、このパッケージの upload フォルダの内容をストアのルートフォルダにコピーすることもできます。
2. Extensions > Extensions に移動し、種類として Payments を選択します。VibeFox CorvusPay Gateway を見つけて Install(緑色の + ボタン)をクリックしてください。管理者ユーザーには、支払い拡張機能の一覧を変更する権限が必要です。
3. Edit(鉛筆のボタン)をクリックして設定ページを開きます。ページ上部のライセンスブロックにある License key に VibeFox ライセンスキーを貼り付け、Activate をクリックしてください(License key を参照)。
4. CorvusPay のテスト店舗の Store ID と Secret Key を入力してください(実際の支払いを受け付ける場合は、本番店舗の Store ID と Secret Key も入力します)。設定ページに表示される Success URL と Cancel URL を、テスト店舗と本番店舗それぞれについて CorvusPay Merchant Center にコピーしてください。
5. Enable/Disable をオンにして Save をクリックします。テスト注文を 1 件行い、その後 Test Mode をオフにすると本番運用に移行します。
OpenCart 4
1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル wcp_corvuspay_gateway.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から読み取るため、名前を変更したパッケージは動作しません。
2. インストール済み拡張機能の一覧に、同じページでパッケージが表示されます。その横の Install(緑色の + ボタン)をクリックしてください。
3. Extensions > Extensions に移動し、種類として Payments を選択します。VibeFox CorvusPay Gateway を見つけて Install(緑色の + ボタン)をクリックし、次に Edit(鉛筆のボタン)をクリックします。
4. ライセンスキー、CorvusPay の Store ID と Secret Key、Merchant Center URLs を、OpenCart 3 のステップ 3 から 5 と同じように入力してください。設定ページとそのフィールドは両バージョンで同じです。異なるのは Success URL と Cancel URL だけです(Success URL と Cancel URL を参照)。
新規インストール時は、支払い方法がオフ、テストモードがオンの状態で始まります。
Configuration
すべての設定は拡張機能のページにあります:Extensions > Extensions > Payments > VibeFox CorvusPay Gateway > Edit。セクションは左側に一覧表示され、一覧の下にある Save ボタンでページ全体を保存します。設定の上部には、テストモードがオンの間は Test mode is on. Payments go to the CorvusPay test environment — no real money is taken. と表示されます。また、ゲートウェイが有効なのに現在のモードの Store ID または Secret Key が空の場合(その場合、入力が完了するまで支払い方法はチェックアウトで非表示になります)や、ストアの既定の通貨が CorvusPay でサポートされていない場合には、警告が表示されます。拡張機能を変更する権限がない場合、ページには設定が表示されますが、保存はできません。
保存時、Title は 128 文字を超えてはならず、Sort Order は整数、Minimum Total は負でない数値である必要があります。また、選択したジオゾーンと注文ステータスが存在している必要があります。そうでない場合は何も保存されず、ページにエラーが一覧表示されます。
CorvusPay
Enable/Disable: Enable CorvusPay Gateway. で支払い方法のオン・オフを切り替えます。Default: off。
Title: チェックアウトで購入者に表示される支払い方法の名前です。注文に保存される支払い方法の名前にもなります。Default: Credit/Debit Card (CorvusPay)。128 文字まで。空欄にすると既定の名前が表示されます。
Description: Confirm Order ステップで、確認ボタンの上に購入者へ表示されるテキストです。Default: Pay securely with your credit or debit card via CorvusPay. テストモードでは、(Test mode — no real payment is taken.) が追加されます。
Sort Order: チェックアウトの支払い方法の中で CorvusPay が表示される順番です。空欄のままにするか、整数を入力してください。
Geo Zone: 選択したジオゾーン内の支払い先住所に対してのみ CorvusPay を提供します。Default: All zones。ジオゾーンは System > Localisation > Geo Zones で設定します。
Minimum Total: CorvusPay が提供されるために注文が達している必要がある、ストアの既定の通貨での注文合計金額です。最低金額を設けない場合は空欄にしてください。
ストアの認証情報
Store ID と Secret Key は、CorvusPay が店舗ごとに発行します(テストと本番は別々)。これらは CorvusPay Merchant Center に表示されます。
Test Mode: CorvusPay のテスト環境(wallet.test.corvuspay.com)と、テスト用の Store ID および Secret Key を使用します。Default: on。オフにすると、wallet.corvuspay.com で実際の支払いを受け付けます。
Test Store ID: CorvusPay テスト店舗の数値の Store ID です。
Test Secret Key: CorvusPay テスト店舗の Secret Key です。HMAC-SHA256 署名に使用されます。
Live Store ID: CorvusPay 本番店舗の数値の Store ID です。
Live Secret Key: CorvusPay 本番店舗の Secret Key です。HMAC-SHA256 署名に使用されます。
Store ID は数字のみで構成される必要があります。それ以外を入力すると、ページに … must contain digits only — the previous value was kept. と表示されますが、他の項目は保存されます。保存済みの Secret Key は二度と表示されません。フィールドは空のままで、Saved — leave empty to keep it. と表示されます。変更したい場合にのみ新しい値を入力してください。保存済みのキーを削除するには、フィールドの下にある Clear the saved value on save にチェックを入れ、Save をクリックします。支払いは、それを開始した店舗の Secret Key で必ず検証されるため、テストの支払いがまだ戻ってくる可能性がある間は、テスト用のキーを入力したままにしてください。
Success URL と Cancel URL
Merchant Center URLs に表示される 2 つのアドレスを、テスト店舗と本番店舗それぞれについて CorvusPay Merchant Center にコピーしてください。支払い後、CorvusPay はこれらのアドレスに購入者を戻します。これらは OpenCart インストールのストアフロントのアドレスから作られるため、ページに表示されたとおりに正確にコピーしてください。
支払い
Transaction Type: カードへの請求方法です。
Payment Page Language: CorvusPay の支払いページの言語です。Site language(既定)は、CorvusPay がサポートしている場合はストアの現在の言語を使用し、それ以外の場合は英語を使用します。Hrvatski、English、Deutsch、Italiano、Srpski、Slovenščina から選ぶこともできます。
Order Status After Payment: Sale の支払いが成功した後の注文ステータスです。選択肢は、Order statuses セクションで選んだ OpenCart のステータスを指します。
注文ステータス
OpenCart は Confirm Order ステップで、ステータスなし(欠落注文)の状態で注文を作成します。以下は、ゲートウェイが設定する OpenCart のステータスです。各フィールドには、OpenCart の注文ステータスが一覧表示されます。OpenCart には On hold ステータスがないため、Authorize only、金額または通貨の不一致、キャンセル後の支払いには、レビューステータスが使われます。注文のメモに理由が記録されます。
Processing status: Order Status After Payment が Processing のときに使用されます。Default: Processing。
Completed status: Order Status After Payment が Completed のときに使用されます。Default: Complete。
On hold (review) status: Authorize only、金額または通貨の不一致、キャンセル後の支払い、または Order Status After Payment を On hold に設定した場合に使用されます。Default: Pending。System > Localisation > Order Statuses で独自のステータスを作成し、ここで選択できます。
詳細設定
Logging: デバッグ情報を OpenCart のログフォルダ(storage/logs)にある corvuspay_p_debug.log.php に書き込みます。このファイルは Web から開くことはできません。このスイッチがオフでも、エラーは常に記録されます。シークレット、署名、購入者のデータは一切記録されません。Default: off。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログを空にできます。
Delete Data: オンにすると、拡張機能をアンインストールしたときにゲートウェイの設定とログファイルが削除されます。注文と CorvusPay の取引データは常に保持されます。Default: off。
インポート / エクスポート
Export: Download JSON で、設定を JSON ファイルとして保存します。Secret Key はエクスポートされません。
Import: 以前にエクスポートした JSON を貼り付け、Import をクリックして設定を復元します。保存済みの Secret Key は保持されます。
チェックアウト
Payment Method ステップで、購入者は支払い方法を選択します(既定では Credit/Debit Card (CorvusPay))。Confirm Order ステップでは、購入者にあなたの説明が表示されます。OpenCart はこのステップで、まだステータスのない注文を作成します。購入者が Confirm Order をクリックすると、ページに Redirecting to CorvusPay for payment. Please wait... と表示され、署名済みのフォームが CorvusPay の支払いページに送信されます。リダイレクトが始まらない場合、購入者は Pay via CorvusPay をクリックします。注文の通貨での注文合計金額、短い説明(Order、注文番号、ストア名)、そして購入者の住所情報とメールアドレス(支払いページに事前入力するため)が送信されます。金額、通貨、モード、取引の種類が変わらない限り、同じ CorvusPay 注文番号が再利用されます。CorvusPay は、その注文に対する 2 回目の支払いを受け付けません。OpenCart 4 では、支払い方法ブロックの Choose ボタンを押し、Payment method options ウィンドウで支払い方法を選んでから、チェックアウトページ下部の Confirm Order をクリックします。ストアが支払い先住所を求めない場合(OpenCart 4 の既定)、カード名義の情報は購入者の名前と配送先住所から取得されます。
支払い後、CorvusPay は購入者を Success URL に戻します。注文が支払い済みとしてマークされるのは、CorvusPay が確認した後だけです。CorvusPay の注文番号はこのストアが発行したものであり、署名は支払いを開始したストアの Secret Key と一致し、金額と通貨は注文と一致する必要があります。その後、注文は OpenCart の標準的な方法でステータスを受け取り、通常の注文メールと在庫の更新が行われ、購入者には OpenCart の注文完了ページが Your CorvusPay payment has been received. とともに表示されます。Authorize only の場合、ページには Your CorvusPay payment has been authorized. The amount will be charged when the shop processes your order. と表示され、レビューステータスの注文の場合は Your payment was received and is being reviewed by the shop. と表示されます。
その時点で支払いを反映できない場合(たとえば、別のリクエストが同じ注文を確認している場合)、購入者には Your payment is being confirmed と Check again ボタンが表示されます。このボタンは、注文がステータスを受け取ると直ちに完了ページへ移動します。Success URL へのリクエストを検証できない場合、購入者には Payment not confirmed と We could not confirm this CorvusPay payment. If your card was charged, please contact the shop — do not pay again. が表示されます。何も変更されません。Success URL は、ストアがメンテナンスモードの間も機能します。OpenCart 3 では支払い拡張機能のリクエストが通過し、OpenCart 4 では拡張機能が Success URL と Cancel URL 用のスタートアップアクションを追加します。OpenCart 4 では、CorvusPay が購入者を戻す際にブラウザがストアのセッションを送信しないため、拡張機能はまず短いページを表示し、ストアから同じアドレスを再度開きます。これにより、購入者のカートとログイン状態は保持されます。
購入者が CorvusPay のページでキャンセルした場合、注文はステータスなしのままとなり、購入者はカートを残したままチェックアウトに戻り、The CorvusPay payment was cancelled and the order was not paid. Your cart is still here — you can try again or choose another payment method. と表示されます。OpenCart 4 では、このメッセージはチェックアウトページの上に表示されます。OpenCart 3 は Confirm Order ステップが表示されるたびに新しい注文を作成します。OpenCart 4 は決済用に 1 つの注文を保持して更新し、新しい試行では新しい CorvusPay 注文番号が発行されます。同じカートの別の注文がすでに支払い済みの場合、購入者は再度支払うのではなく、完了ページに案内されます。
OpenCart 4 は、成功ページが表示されるまで注文をチェックアウト内に保持します。その間に注文が支払いなしで閉じられた場合(たとえばキャンセルした場合)、Confirm Order または CorvusPay からの戻りにより、購入者は Your previous order was cancelled without a payment. Please confirm the order again to pay with a new order. と表示されてチェックアウトに戻ります。注文にすでにステータスがあり、その後カートが変更されている場合(商品や数量が異なる場合)、メッセージは Your previous order is already placed. The cart has changed since then: please confirm the new order to pay for it. です。どちらの場合も、次の Confirm Order でそのカートの新しい注文の支払いが行われます。
支払いを開始できない場合、購入者は Confirm Order ステップにとどまり、ボタンの上に短いメッセージが表示されます。CorvusPay is not configured. Please choose another payment method.、CorvusPay does not accept payments in …、または This order total cannot be paid via CorvusPay (it must be greater than zero with at most 2 decimals). Please choose another payment method. です。
注文が確定するのは、CorvusPay が購入者を Success URL に戻したときだけです。サーバー間の通知はありません。購入者が支払い直後にブラウザを閉じた場合、注文はステータスなしのままです。この拡張機能では、OpenCart からの返金、キャプチャ、キャンセルはできません(CorvusPay のサーバー API にはクライアント証明書が必要です)。また、保存済みカード、サブスクリプション、分割払い、ストア上のカードフォームにも対応していません。
注文
注文ステータス
ステータスなし(欠落注文): 購入者は CorvusPay に送られ、確定した支払いを伴って戻らなかったか、支払いをキャンセルしました。Sales > Orders では、Order Status フィルターを Missing Orders に設定した場合にのみ、このような注文が表示されます。購入者が支払ったものの戻らなかった場合は、CorvusPay Merchant Center で支払いを確認し、注文ステータスを手動で設定してください。
Processing、Completed、またはレビューステータス: Sale の支払いが確定しました。ステータスは Order Status After Payment に従います。メモには、CorvusPay の注文番号、承認コード、カードの種類が表示されます。
レビューステータス、承認済み: Authorize only が選択されています。CorvusPay Merchant Center で支払いをキャプチャし、その後で注文ステータスを変更してください。
レビューステータス、金額または通貨の不一致: 支払われた金額または通貨が注文と一致しません。CorvusPay Merchant Center で支払いを確認するまで、発送しないでください。
レビューステータス、キャンセル後の支払い: 購入者がキャンセルした支払い試行に対して、成功した支払いが届きました。CorvusPay Merchant Center で注文を処理するか、支払いを返金してください。
すでに支払い済みの注文に対して別の支払いが成功した場合、注文は変更されません。メモで、CorvusPay Merchant Center を確認し、必要に応じて重複した支払いを返金するよう求められます。1 つの注文がすでに支払い済みのときに、同じカートの別の注文に対して支払いが届いた場合、その注文はステータスなしのままとなり、メモは支払い済みの注文に追加されます。
メモは、購入者には表示されない注文の History の項目です。
VibeFox CorvusPay Gateway タブ
Sales > Orders で、CorvusPay で支払われた注文を開きます。注文ページの下部、History と Additional の隣にある VibeFox CorvusPay Gateway タブには、CorvusPay order number、支払い試行の Status、Transaction type、Amount(CorvusPay が報告した場合は受け取った金額も)、Approval code、Transaction、Card の種類、そして CorvusPay notes が表示されます。テスト支払いには Test のマークが付きます。このタブは読み取り専用で、拡張機能にアクセスできるユーザーに表示されます。
返金: OpenCart からの返金、キャプチャ、キャンセルはサポートされていません。これらは CorvusPay Merchant Center で行い、その結果を OpenCart に手動で記録してください。Sales > Returns での商品返品では、CorvusPay を通じて返金は行われません。
ライセンスキー
この拡張機能は、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox CorvusPay Gateway は、Extensions > Extensions > Payments > VibeFox CorvusPay Gateway > Edit の最初のブロックで、設定の上に表示されます。キーを License key に貼り付け、Activate をクリックしてください。その後、ブロックにはマスクされたキー、ステータス(たとえばライセンスの有効期限日と、あなたのドメイン)、そしてボタンが表示されます。ボタンは、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key です。その下には、Product: opencart-payment-corvuspay という行と、vibefox.net のアカウントを開く Manage licenses and domains in your account のリンクがあります。キーを変更できるのは、この拡張機能に対する Modify 権限を持つ管理者ユーザーだけです。ブロックのテキストは管理画面の言語に従います(英語とロシア語が含まれます)。
キーが受け付けられなかった場合、ブロックには理由が表示されます。たとえば Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on です。ストアのアドレスを変更した後、またはアカウントでドメインの枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、拡張機能は最後に確認されたステータスで動作を続けます。
1 つのキーは 1 つのドメインで使用できます。ドメインとは、OpenCart の設定にあるストアのアドレスです。ストアからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、チェックアウトでは CorvusPay は購入者に表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。同じブラウザで管理画面にログインしている管理者ユーザーには、ストアで支払い方法が表示されたままになり、(unlicensed — visible to admins only) と表示されます。そのため、キーを購入する前に拡張機能を設定してテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面へのログインを認識しないため、有効なキーがない場合は、すべての人に対して支払い方法が非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× をクリックして閉じると、7 日間は表示されなくなります。既存の注文には影響しません。購入者が CorvusPay から戻ったときには、すでに開始された支払いも確定します。
ライセンスの有効期限が切れても、拡張機能は動作し続けますが、アップデートとサポートには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスは自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週に 1 回です。cron ジョブは必要ありません。拡張機能をアンインストールすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
CorvusPay がチェックアウトに表示されない: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードの Store ID と Secret Key が入力されていること(テストモードでは Test Store ID と Test Secret Key、本番モードでは Live Store ID と Live Secret Key)、そしてチェックアウトの通貨が CorvusPay でサポートされていることを確認してください。また、支払い先住所が選択した Geo Zone に含まれていること、注文が Minimum Total に達していることも確認してください。
支払いは完了したが、注文がステータスなしのまま: Success URL が CorvusPay Merchant Center に入力されていないか、OpenCart の Secret Key がストアと一致していない可能性が高いです。拡張機能ページの Log フィールドで INVALID signature を探してください(エラーは常に記録されます)。購入者が戻る前にブラウザを閉じた場合も、注文はステータスなしのままになります。その場合は Merchant Center で支払いを確認し、注文ステータスを手動で設定してください。
購入者に Payment not confirmed と表示される: Success URL へのリクエストが拒否されました。必須フィールドが欠けていた、CorvusPay の注文番号がこのストアによって発行されたものではなかった、そのストアの Secret Key が空だった、または署名が一致しなかった、のいずれかです。何も変更されません。ログに理由が表示されます。
購入者に Your payment is being confirmed が長時間表示される: 注文ステータスを設定できませんでした。ログに理由が表示されます。Merchant Center で支払いを確認してください。
購入者に This order total cannot be paid via CorvusPay と表示される: 合計金額がゼロであるか、小数点以下が 2 桁を超えています。
購入者に CorvusPay is not configured または CorvusPay does not accept payments in … と表示される: 現在のモードの Store ID または Secret Key がない、またはチェックアウトの通貨がサポートされていません。
購入者に This payment method is not available. Please reload the checkout page. と表示される: チェックアウトのセッションが注文と一致しなくなった、またはその間に支払い方法がオフにされました。購入者はチェックアウトを再読み込みします。
注文がレビューステータスになっている: VibeFox CorvusPay Gateway タブのメモを確認してください。Authorize only が選択されている、支払われた金額または通貨が注文と一致しなかった、購入者がキャンセルした後に支払いが届いた、または Order Status After Payment が On hold に設定されている、のいずれかです。
開発者向け:フォームに署名する前に、拡張機能はフォームのフィールドと注文を伴って OpenCart イベント corvuspay_p_form_params を発生させます。
アンインストール
Extensions > Extensions に移動し、種類として Payments を選択して、VibeFox CorvusPay Gateway の横にある Uninstall(赤い − ボタン)をクリックしてください。この拡張機能のライセンスキーとライセンスステータスは、常に削除されます。OpenCart は、拡張機能自身の設定を常に削除します。Enable/Disable、Sort Order、Geo Zone、Minimum Total、および Order statuses セクションのステータスです。これらは再インストール時に既定値に戻ります。拡張機能の OpenCart イベントも削除されます(OpenCart 4 では、そのイベントに加え、メンテナンスモードでも CorvusPay を通過させるスタートアップアクションも削除されます)。Delete Data がオンの場合、それ以外のゲートウェイ設定(タイトル、説明、Store ID、Secret Key、テストモード、支払い設定、ログ記録)とログファイルが削除されます。オフの場合は、後日の再インストールのために保持されます。CorvusPay の取引データは常に保持されるため、再インストール後に古い注文の CorvusPay タブが再び表示されます。既存の注文は、支払いのメモを保持します。
OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer に移動し、インストール済み拡張機能の一覧で VibeFox CorvusPay Gateway の横にある Uninstall(オレンジ色の − ボタン)をクリックしてから、Delete(赤いごみ箱のボタン)をクリックして、アップロードしたパッケージを削除します。
CorvusPay は、その所有者の商標です。この拡張機能は CorvusPay と提携しておらず、CorvusPay による推奨も受けていません。
