VibeFox CCAvenue for OpenCart — ヘルプ

要件

OpenCart: 3.0.x（3.0.5.0 で動作確認済み）または 4.0.2 以降（4.1.0.3 で動作確認済み）。

PHP: 8.0 以降。OpenSSL 拡張機能が必要です（リクエストの暗号化とレスポンスの復号に使用します）。

CCAvenue アカウント: Merchant ID、Access Code、Working Key を持つ CCAvenue の加盟店アカウントが必要です。Access Code と Working Key はウェブサイトのドメインごとに発行されるため、このストアのドメイン用に生成してください。テスト環境でも CCAvenue は同じ認証情報を使用します。テストアクセスは CCAvenue がお客様のアカウントで有効にする必要があります。この拡張機能は CCAvenue India のエンドポイントを使用します。

通貨: 注文の通貨はそのまま CCAvenue に送信されます。CCAvenue のアカウントはデフォルトで INR を受け付けます。その他の通貨を使用するには、CCAvenue アカウントで複数通貨処理を有効にする必要があります。

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

インストール

このダウンロードは、OpenCart の両バージョン用パッケージを含む 1 つの zip ファイルです。お使いのコンピューターで解凍します。中には README.txt、OpenCart 3 用パッケージ wcp_ccavenue_payment-oc3-(version).ocmod.zip、OpenCart 4 用パッケージ wcp_ccavenue_payment.ocmod.zip が含まれています。お使いの OpenCart のバージョンに対応するパッケージだけをインストールします。ライセンスキーは両方のバージョンで同じです。

OpenCart 3

1. 管理画面で Extensions > Installer に移動し、Upload をクリックして、ファイル wcp_ccavenue_payment-oc3-(version).ocmod.zip を選択します。この拡張機能には OCMOD の変更が含まれないため、Extensions > Modifications を更新する必要はありません。インストーラーを使う代わりに、このパッケージの upload フォルダの内容をストアのルートフォルダにコピーすることもできます。

2. Extensions > Extensions に移動し、種類として Payments を選択します。VibeFox CCAvenue Payment を見つけて、Install（緑色の + ボタン）をクリックします。管理者ユーザーには、支払い拡張機能の一覧を変更する権限が必要です。

3. Edit（鉛筆のボタン）をクリックして設定ページを開きます。ページ上部のライセンスブロックにある License key に VibeFox ライセンスキーを貼り付け、Activate をクリックします（ライセンスキーを参照）。

4. CCAvenue のダッシュボードから Merchant ID、Access Code、Working Key を入力し、Enable/Disable をオンにして Save をクリックします。

5. テスト中は Test mode をオンのままにし、実際の支払いを受け付けるときにオフにします。CCAvenue のダッシュボードで設定する必要はありません。戻り先アドレスは支払いごとに送信されます。

OpenCart 4

1. 管理画面で Extensions > Installer に移動し、Upload をクリックして、ファイル wcp_ccavenue_payment.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から取得するため、名前を変更したパッケージは動作しません。

2. インストール済みの拡張機能の一覧に、同じページでパッケージが表示されます。その横の Install（緑色の + ボタン）をクリックします。

3. Extensions > Extensions に移動し、種類として Payments を選択します。VibeFox CCAvenue Payment を見つけて、Install（緑色の + ボタン）をクリックし、次に Edit（鉛筆のボタン）をクリックします。

4. ライセンスキーと CCAvenue の認証情報は、OpenCart 3 の手順 3〜5 と同じように入力します。設定ページとそのフィールドは両方のバージョンで同じです。戻り URL だけが異なります（戻り URL を参照）。

新規インストール時は、支払い方法がオフ、テストモードがオンの状態で始まります。

設定

すべての設定は拡張機能のページにあります：Extensions > Extensions > Payments > VibeFox CCAvenue Payment > Edit。セクションは左側に一覧表示されます。一覧の下にある Save ボタンで、ページ全体が保存されます。設定の上部には、CCAvenue が有効なのに Merchant ID、Access Code、Working Key のいずれかが未入力の場合に警告が表示されます（3 つすべてが入力されるまで、チェックアウトで支払い方法は表示されません）。支払い方法がテストモードで有効な場合は CCAvenue test mode is on: customers are sent to test.ccavenue.com and no real money is taken. と表示されます。また、ストアのデフォルト通貨が INR でない場合は、複数通貨処理について注意が表示されます。拡張機能を変更する権限がない場合、ページには設定が表示されますが、保存はできません。

保存時、Title は空にできず（最大 128 文字）、Sort Order は整数である必要があり、Total は 0 以上の数値である必要があります。また、ジオゾーンと注文ステータスが存在している必要があります。条件を満たさない場合、何も保存されません。

CCAvenue

Enable/Disable: Enable CCAvenue Payment Gateway は、支払い方法のオン／オフを切り替えます。デフォルト：オフ。

Title: チェックアウトで顧客に表示される支払い方法の名前です。注文にも、この名前が支払い方法として保存されます。デフォルト：CCAvenue。必須。

Description: Confirm Order のステップで、確認ボタンの上に顧客に表示されるテキストです。デフォルト：Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through CCAvenue。

Sort Order: チェックアウトの支払い方法の中で CCAvenue が表示される順序です。空欄のままにするか、整数を入力します。

Geo Zone: 選択したジオゾーン内の請求先住所に対してのみ CCAvenue を提供します。デフォルト：All zones。ジオゾーンは System > Localisation > Geo Zones で設定します。

Total: CCAvenue が提供されるために注文が達している必要がある、チェックアウト時の合計金額です（ストアのデフォルト通貨で指定）。空欄にすると、どの金額でも CCAvenue を提供します。

API 認証情報

CCAvenue の加盟店ダッシュボード（M.A.R.S.）にログインし、Settings > API Keys を開きます。このストアのドメイン用に Access Code と Working Key を生成します。認証情報内の空白は、保存時に削除されます。

Merchant ID: 数字のみで構成される CCAvenue の Merchant ID です。数字以外の文字が含まれている場合、保存時に CCAvenue: the Merchant ID must contain digits only — the previous value was kept. と表示され、以前に保存された値は維持され、他の設定は保存されます。

Access Code: このウェブサイトの Access Code です（Settings > API Keys）。

Working Key: このウェブサイトの Working Key（暗号化キー）です。支払いリクエストを暗号化し、CCAvenue のレスポンスを検証する唯一の手段となるため、秘密にしてください。保存済みの Working Key は二度と表示されません。フィールドは空のままになり、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。削除するには、フィールドの下にある Clear saved Working Key にチェックを入れ、Save をクリックします。

Test mode: 顧客を CCAvenue のテスト環境（test.ccavenue.com）に送ります。CCAvenue はテストと本番で同じ Merchant ID、Access Code、Working Key を使用します。テストアクセスは CCAvenue がお客様のアカウントで有効にする必要があります。テストモードでは、Confirm Order のステップに TEST MODE: no real transactions will be processed. と表示されます。デフォルト：オン。実際の支払いを受け付ける場合はオフにしてください。

戻り URL

CCAvenue は、このセクションに表示されるアドレスに顧客を戻します。OpenCart 3 では https://your-store/index.php?route=extension/payment/wcp_ccavenue_payment/back のような形式、OpenCart 4 では https://your-store/index.php?route=extension/wcp_ccavenue_payment/payment/wcp_ccavenue_payment.back のような形式です。この URL は OpenCart インストールのストアフロントのアドレスから作られます。拡張機能は支払いのたびにこの URL（リダイレクト先およびキャンセル先として）を送信するため、CCAvenue 側で設定する必要はありません。この URL は、CCAvenue に登録されたドメインに属している必要があります。

注文

OpenCart は Confirm Order のステップで、ステータスのない注文（欠落した注文）を作成します。注文にステータスが付与されるのは、CCAvenue の暗号化されたレスポンスが検証された後だけです。支払いが失敗またはキャンセルされた場合、注文はステータスなしのままとなり、顧客はカートを保持したままチェックアウトに戻ります。以下の各フィールドには、お使いの OpenCart の注文ステータスが一覧表示されます。

Order Status After Payment: 支払いが成功した場合（CCAvenue のステータスが Success で、金額と通貨が検証済み）。デフォルト：処理中。

Awaiting Payment Status: Awaited：銀行がまだ支払いを確認していない状態です。同じ tracking ID について CCAvenue が Success を報告すると、注文に Order Status After Payment が設定されます。デフォルト：支払い待ち。

On Hold (Review) Status: CCAvenue が注文合計と異なる金額または通貨を報告した場合、またはキャンセル済みの注文に対して支払いが届いた場合です。メモにその旨が記録されます。デフォルト：OpenCart に保留中のステータスがないため、支払い待ち。独自のステータスは System > Localisation > Order Statuses で作成し、ここで選択できます。

Cancelled Payment Status: 保留中だった支払いがその後中止された場合です（同じ tracking ID で Aborted）。デフォルト：キャンセル済み。

Failed Payment Status: 保留中だった支払いがその後失敗した場合です（同じ tracking ID で Failure、Invalid、または Timeout）。以前の試行の失敗は注文を変更しません。デフォルト：失敗。

詳細設定

Debug log: CCAvenue のイベントを OpenCart のログフォルダ（storage/logs）内の ccavenue_p_debug.log.php に書き込みます。このファイルは Web から開くことはできません。記録されるのは注文の参照番号、tracking ID、ステータスのみです。キー、カード情報、メールアドレス、住所は記録されません。デフォルト：オフ。オフの間は、エラーを含め何も書き込まれません。

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

Delete data on uninstall: オンにすると、拡張機能のアンインストール時に拡張機能の設定とログが削除されます。注文と CCAvenue の支払い参照情報は残るため、再インストール後も古い支払いの遅延した戻りが処理されます。デフォルト：オフ。

インポート / エクスポート

Export: Download JSON で、設定を JSON ファイルとして保存します。Working Key はエクスポートされません。

Import: 以前にエクスポートした JSON を貼り付け、Import をクリックして設定を復元します。保存済みの Working Key は維持されます。

チェックアウト

Payment Method のステップで、顧客は支払い方法を選択します（デフォルトは CCAvenue）。Confirm Order のステップでは、顧客にあなたの説明文が表示されます。OpenCart はこのステップで注文を作成しますが、まだステータスはありません。顧客が Confirm Order をクリックすると、このステップに Thank you for your order. You are being redirected to CCAvenue to complete the payment. と表示され、顧客は CCAvenue の支払いページに移動します。ブラウザがそのページに移動している間、Pay via CCAvenue ボタンが表示されます。OpenCart 4 では、顧客は支払い方法ブロックの Choose ボタンを押して、Payment method options ウィンドウで支払い方法を選択し、チェックアウトページ下部の Confirm Order をクリックします。

試行ごとに、OpenCart の注文番号と時刻から作られる新しい CCAvenue の注文参照番号が発行されます。注文の合計金額と通貨、請求先情報、配送先住所（注文が発送される場合で、配送先住所が請求先住所と異なるとき）、および試行ごとの秘密のトークンが、暗号化されたリクエストで送信されます。氏名と住所は CCAvenue が受け付ける文字と長さに整えられます。国と都道府県は名称として、電話番号は数字のみで送信されます。顧客は CCAvenue のページで、カード、Net Banking、UPI、ウォレット、または EMI を選択します。OpenCart 4 では、デフォルトでは請求先住所を入力させません。その場合、請求先情報は配送先住所から取得されます。

支払い後、CCAvenue は暗号化されたレスポンスとともに顧客をストアに戻します。注文が支払い済みとしてマークされるのは、CCAvenue が確認した後だけです。レスポンスは Working Key で復号でき、このストアの試行に属し、送信された金額および通貨と注文合計が一致している必要があります。その後、注文は OpenCart の標準的な方法でステータスを受け取り、通常の注文メールが送信されて在庫が更新されます。顧客には OpenCart の注文完了ページが表示され、Your CCAvenue payment has been received. と表示されます。Awaited の支払いの場合、ページには Your CCAvenue payment is awaiting confirmation from your bank. The order will be processed as soon as the payment is confirmed. と表示されます。金額または通貨の不一致があった場合は、Your payment was received and is being reviewed by the store. と表示されます。OpenCart 4 では、CCAvenue が顧客を戻す際にブラウザがストアのセッションを送信しないため、レスポンスの適用後に、拡張機能はストアの戻りアドレスを開き直す短いページを表示します。これにより、顧客はカートとログイン状態を保持できます。

支払いが失敗すると、顧客は Payment was not completed. Please try again or choose a different payment method. と表示されたチェックアウトに戻ります。顧客が CCAvenue のページでキャンセルした場合は、Payment was cancelled. You may try again. と表示されます。レスポンスを検証できない場合は、We could not confirm the payment result. If your account was charged, please contact us before paying again. と表示されます。OpenCart 4 では、これらのメッセージはチェックアウトページの上部に表示されます。これらの場合、注文はステータスなしのままとなり、カートは保持されるため、顧客は再度支払うことができます。OpenCart 3 では、Confirm Order のステップが表示されるたびに新しい注文を作成します。OpenCart 4 はチェックアウトの注文を 1 つ保持して更新します。各試行は独自の CCAvenue 注文参照番号を持ちます。CCAvenue は開始された支払いをキャンセルできないため、以前の試行の遅延した成功した支払いも、その試行自体の注文に適用されます。カートは一度だけ支払われます。すでに別の注文で支払われたカートは CCAvenue に再送信されず（顧客は成功ページに移動します）、同じカートが（たとえば 2 つのブラウザタブで）それでも 2 回支払われた場合は、2 番目の注文はステータスなしのままとなり、支払い済みの注文には、顧客が二重に請求された可能性があるというメモが付きます。そのため、CCAvenue のダッシュボードで返金できます。

OpenCart 4 では、成功ページが表示されるまで注文がチェックアウト内に保持されます。その間にこの注文が閉じられた場合、Confirm Order をクリックすると顧客はチェックアウトに戻され、次に Confirm Order をクリックしたときに、そのカートの新しい注文が支払われます。Awaited の支払いが中止されていた場合のメッセージは Payment was cancelled. You may try again.、失敗していた場合は Payment was not completed. Please try again or choose a different payment method. です。支払いが行われていた注文をストアで閉じた場合は、This order can no longer be paid (it was closed by the store). Please confirm your order again. と表示されます。注文にすでにステータスがあり、その後カートが変更されている（他の商品や数量が異なる）場合は、Your previous order is already paid. Please confirm the order again: the cart will be paid with a new order. と表示されます。

結果は、顧客が CCAvenue から戻ったときにのみ取得されます。サーバー間の通知やステータスの問い合わせはありません。顧客が戻る前にブラウザを閉じた場合、注文はステータスなしのままとなるため、CCAvenue のダッシュボードで支払いを確認してください。この拡張機能には、OpenCart からの返金、保存済みカード、サブスクリプションや定期支払い、サイト上のカードフォーム、CCAvenue UAE やその他の地域プラットフォームのサポートはありません。

注文

注文ステータス

ステータスなし（欠落した注文）: 顧客は CCAvenue に送られましたが戻っていない、または支払いが失敗またはキャンセルされました。Sales > Orders では、これらの注文は Order Status フィルターを Missing Orders に設定した場合にのみ表示されます。顧客が戻ってこない場合は、CCAvenue のダッシュボードで支払いを確認してください。

Order Status After Payment (default Processing): 支払いが確認されました。メモには、銀行の参照番号、tracking ID、支払いモードが表示されます。

Awaiting Payment Status (default Pending): CCAvenue は支払いを Awaited（銀行がまだ確認していない）として報告しました。資金がまだ回収される可能性がある間は、注文が失敗としてマークされることはなく、メモは、注文を処理する前に CCAvenue のダッシュボードで支払いを確認するよう求めます。同じ tracking ID を持つ後続のレスポンスも適用されます。Success は Order Status After Payment を設定し、Failure は Failed Payment Status を設定し、Aborted は Cancelled Payment Status を設定します。OpenCart は、これらの変更を顧客に通知します。

On Hold (Review) Status (default Pending): CCAvenue が、金額または通貨が注文合計または送信された内容と異なる支払いを確認した場合、あるいは顧客が注文のキャンセル後または失敗後に支払った場合です。メモには、受け取った金額と想定された金額が表示されます。CCAvenue のダッシュボードで支払いを確認してから、注文を処理するか支払いを返金してください。

遅延した失敗が支払い済みの注文を変更することはなく、手動で完了した注文も変更されません。すでに支払い済みの注文に対して別の成功した支払いが届いた場合（たとえば 2 つのブラウザタブから）、注文は変更されません。メモは、CCAvenue のダッシュボードで重複分を返金するよう求めます。

メモは注文の History のエントリで、顧客には表示されません。

VibeFox CCAvenue Payment tab

Sales > Orders で、CCAvenue で支払われた注文を開きます。注文ページの下部、History と Additional の隣にある VibeFox CCAvenue Payment タブには、CCAvenue order ID（テスト支払いには Test mode ラベル付き）、Tracking ID、Status、Bank reference、Payment mode とカード名、Amount sent と Amount received、Date、CCAvenue の Message、そして注文の CCAvenue notes が表示されます。このタブは、拡張機能へのアクセス権を持つ管理者ユーザーに表示されます。

返金

OpenCart からの返金はサポートされていません。CCAvenue のダッシュボードで支払いを返金し、その後 OpenCart で手動により返金を記録してください（例：注文ステータスを変更します）。

ライセンスキー

この拡張機能は、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox CCAvenue Payment は、Extensions > Extensions > Payments > VibeFox CCAvenue Payment > Edit の最初のブロックで、設定の上にあります。キーを License key に貼り付け、Activate をクリックします。その後、ブロックにはマスクされたキー、ステータス（たとえばライセンスの有効期限日とお使いのドメイン）、そしてボタン Check now（ステータスを再確認）、Change key（別のキーを入力）、Remove key（このストアからキーを削除）が表示されます。その下には、Product: opencart-payment-ccavenue という行と、お使いの 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 のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで顧客に CCAvenue は表示されません。それでも支払いが開始された場合、顧客には This payment method is not available. Please choose another one. と表示されます。同じブラウザで管理画面にログインしている管理者ユーザーには、ストアでその支払い方法が (unlicensed — visible to admins only) と表示されたまま見えるため、キーを購入する前に拡張機能をセットアップしてテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面へのログインを認識しないため、有効なキーがない場合は、支払い方法がすべての人に対して非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× で閉じると、7 日間非表示にできます。既存の注文は影響を受けません。開始済みの支払いは、顧客が CCAvenue から戻ったときに引き続き確認されます。

ライセンスが期限切れになっても、拡張機能は動作し続けますが、アップデートとサポートには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスが自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。拡張機能をアンインストールすると、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

CCAvenue does not appear at checkout: ライセンスが有効であること、Enable/Disable がオンであること、そして 3 つの認証情報すべてが設定されていることを確認してください：Merchant ID、Access Code、Working Key。いずれかが欠けている場合、設定ページに警告が表示されます。また、支払い先住所が選択した Geo Zone に含まれていること、および注文が設定の Total に達していることも確認してください。

The payment went through, but the order stays without a status: 顧客が CCAvenue からストアに戻らなかった場合です（たとえばブラウザを閉じたなど）。この拡張機能にはサーバー間の通知がありません。CCAvenue のダッシュボードで支払いを確認し、注文を手動で更新してください。

Every payment ends with We could not confirm the payment result: レスポンスを復号できません。Working Key が間違っている、別のドメインに属している、または余分な文字を含んだままコピーされた可能性があります。このストアのドメイン用にキーを生成し、もう一度貼り付けてください。Debug log をオンにして、拡張機能のページにある Log フィールドを確認してください。

CCAvenue shows an error before the payment page: Access Code と Working Key がこのドメイン用に生成されていること、戻り URL が CCAvenue に登録されたドメインに属していること、そしてテストモードでは、お客様のアカウントで CCAvenue がテストアクセスを有効にしていることを確認してください。INR 以外の通貨の場合は、CCAvenue アカウントで複数通貨処理を有効にする必要があります。

The customer sees This payment method is temporarily unavailable: 認証情報のいずれかが欠けているか、注文合計がゼロです。Debug log に理由が表示されます。

The customer sees This payment method is not available. Please reload the checkout page.: チェックアウトのセッションが注文と一致しなくなったか、その間に支払い方法がオフにされました。顧客はチェックアウトを再読み込みします。

The customer sees Payment gateway error: encryption failed: リクエストを暗号化できませんでした。PHP の OpenSSL 拡張機能がインストールされているか確認してください。

The Merchant ID does not change on save: 値に数字以外の文字が含まれています。Merchant ID の数字だけを入力してください。

Order is in the review or awaiting status: VibeFox CCAvenue Payment タブのメモを確認してください（注文ステータスを参照）。CCAvenue のダッシュボードで支払いを確認してから、注文を処理するか支払いを返金してください。

開発者向け：リクエストが暗号化される前に、この拡張機能はリクエストパラメーターと注文を伴って OpenCart イベント ccavenue_p_request_params を発行します（例：merchant_param2 から merchant_param5 を設定する場合。amount、currency、order_id、merchant_param1 は変更しないでください）。

アンインストール

Extensions > Extensions に移動し、種類として Payments を選択して、VibeFox CCAvenue Payment の横にある Uninstall（赤い − ボタン）をクリックします。この拡張機能のライセンスキーとライセンスステータスは、常に削除されます。OpenCart は、拡張機能自身の設定を常に削除します。Enable/Disable、Sort Order、Geo Zone、Total、および Orders セクションの注文ステータスです。これらは再インストール時にデフォルトに戻ります。拡張機能の OpenCart イベントも削除されます（OpenCart 4 では、イベントとスタートアップアクションも削除されます。スタートアップアクションは、メンテナンスモード中でも顧客の戻りを通すためのものです）。Delete data on uninstall がオンの場合、その他の拡張機能の設定（タイトル、説明、認証情報、テストモード、ログ記録）とログも削除されます。オフの場合、後で再インストールするために保持されます。CCAvenue の支払い参照情報は常に保持されます。既存の注文は支払いのメモを保持します。

OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer に移動し、インストール済みの拡張機能の一覧にある VibeFox CCAvenue Payment の横の Uninstall（オレンジ色の − ボタン）をクリックしてから、アップロードしたパッケージを削除するために Delete（赤いゴミ箱のボタン）をクリックします。

CCAvenue は、それぞれの所有者の商標です。この拡張機能は CCAvenue と提携しておらず、CCAvenue による推奨も受けていません。