VibeFox CCAvenue for PrestaShop — ヘルプ

要件

PrestaShop：8.0 から 9.x。

PHP：8.0 以降（OpenSSL 拡張機能を有効にしたもの）。リクエストの暗号化と応答の復号に使用されます。古い PHP バージョンでは、または 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 つのドメインでのみ使用できます。

インストール

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

2. アップロードが完了したら Configure をクリックします。後でモジュール一覧から VibeFox CCAvenue Payment を探し、Configure をクリックすることもできます。

3. Configure ページ上部のライセンスブロックにある License key に VibeFox ライセンスキーを貼り付け、Activate をクリックします（ライセンスキーの項目を参照）。

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

5. テスト中は Test mode をオンのままにし、実際の決済を受け付ける際にオフにします。

インストール時に、モジュールは 2 つの注文ステータス Awaiting CCAvenue payment と CCAvenue payment on hold を作成します。PrestaShop は、新しい決済モジュールをすべての通貨、国、顧客グループで有効にします。Payment > Preferences で制限できます。

設定

すべての設定はモジュールのページにあります：Modules > Module Manager > VibeFox CCAvenue Payment > Configure。各セクションには独自の 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 ではない場合にはマルチカレンシー処理について注意が表示されます。

CCAvenue

Enable/Disable：Enable CCAvenue Payment Gateway は、決済方法をオンまたはオフにします。既定値：オフ。

Title：チェックアウトで購入者に表示される決済方法の名称です。注文にも決済方法名として保存されます。既定値：CCAvenue。

Description：チェックアウトで決済方法の下に表示される説明文です。既定値：Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through 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 をクリックすると、保存済みの Working Key を削除します。フィールドが空の場合は、保存済みの値が維持されます。

Test mode：購入者を CCAvenue のテスト環境（test.ccavenue.com）に誘導します。CCAvenue はテストと本番で同じ Merchant ID、Access Code、Working Key を使用します。テストアクセスは CCAvenue がアカウントに対して有効にする必要があります。テストモードでは、チェックアウトの決済方法の下に TEST MODE: no real transactions will be processed. が表示されます。既定値：オン。実際の決済を行う場合はオフにしてください。

Return URL

CCAvenue は、このセクションに表示されているアドレスに購入者を戻します。フレンドリー URL を使用すると、https://your-shop/module/wcp_ccavenue_payment/return のような形になり、/en/ のような言語コードが付く場合もあります。モジュールはすべての決済にこの URL を（リダイレクト URL およびキャンセル URL として）送信するため、CCAvenue 側で設定する必要はありません。CCAvenue に登録されたドメインに属している必要があります。

詳細設定

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

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

Delete data on uninstall：オンにすると、モジュールのアンインストール時に、モジュールの設定、ログ、CCAvenue の注文参照が削除されます。注文とモジュールの注文ステータスは残ります。既定値：オフ。

チェックアウト

決済ステップで購入者は決済方法（既定では CCAvenue）を選び、確定します。ページには Thank you for your order. You are being redirected to CCAvenue to complete the payment. が表示され、購入者は CCAvenue の決済ページに移動します。JavaScript が無効な場合、購入者は Pay via CCAvenue または Back to checkout をクリックします。この時点ではまだ注文は存在しません。

各試行には、カート番号と時刻から構成される新しい CCAvenue 注文参照が割り当てられます。カートの合計金額と通貨、請求先情報、配送先住所（請求先住所と異なる場合）、試行の秘密トークンは、暗号化されたリクエストで送信されます。氏名と住所は CCAvenue が受け付ける文字と長さに整えられます。国と州は名称で、電話番号は数字のみで送信されます。購入者は CCAvenue のページで、カード、ネットバンキング、UPI、ウォレット、EMI のいずれかを選択します。

決済後、CCAvenue は暗号化された応答とともに購入者を戻します。注文は、CCAvenue が確認した後にのみ支払い済みとしてマークされます。応答は貴店の Working Key で復号でき、このストアの試行に属し、送信された金額および通貨、カートの合計と一致している必要があります。その後、注文が作成され、購入者には標準の注文確認ページが表示され、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 shop. と表示されます。保留中の注文がその後、決済なしでキャンセルされたり失敗したりした場合、確認ページには Your CCAvenue payment was not completed. Please contact us about this order. と表示されます。

決済に失敗した場合、購入者は 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. です。これらの場合は注文が作成されず、カートが保持されるため、購入者は再度支払うことができます。カートにすでに注文がある場合、新しい試行は二重の決済ではなく、その注文の確認ページに直接移動します。

結果は、購入者が CCAvenue から戻ったときのみ取得されます。サーバー間の通知も、ステータスの照会もありません。購入者が戻る前にブラウザーを閉じた場合、注文は作成されません。その場合は CCAvenue のダッシュボードで決済を確認してください。本モジュールには、PrestaShop からの返金、保存済みカード、定期購読や定期払い、サイト上のカード入力フォーム、CCAvenue UAE やその他の地域別プラットフォームのサポートはありません。

注文

注文ステータス

No order yet：購入者は CCAvenue に移動したものの戻っていないか、決済が失敗またはキャンセルされました。カートのみが存在します。購入者が戻らない場合は、CCAvenue のダッシュボードで決済を確認してください。

Payment accepted：決済が確認されました。決済は CCAvenue のトラッキング ID を取引 ID として記録され、メモには銀行参照番号、トラッキング ID、決済モードが表示されます。

Awaiting CCAvenue payment：CCAvenue は決済を Awaited（銀行による確認がまだ）として報告しました。お金がまだキャプチャされる可能性があるうちは、注文が失敗としてマークされることはありません。発送する前に、CCAvenue のダッシュボードで確認してください。同じトラッキング ID で後から届いた応答も適用されます：Success は Payment accepted、Failure は Payment error、Aborted は Canceled に設定されます。

CCAvenue payment on hold：CCAvenue は、カートまたは送信内容と金額または通貨が異なる決済を確認しました（例：決済の開始後に、別のタブでカートが変更された場合）。あるいは、注文がキャンセルされた後に購入者が支払いました。メモには、受け取った金額と想定された金額が表示されます。通貨が一致する場合、CCAvenue が報告した金額は注文の決済として記録されます。CCAvenue のダッシュボードで決済を確認し、その後に注文を処理するか、決済を返金してください。

遅れて届いた失敗の応答が、支払い済みの注文を変更することはありません。すでに支払い済みの注文に対して別の成功した決済が届いた場合（例：2 つのブラウザータブから）、注文は変更されません。メモで、重複分を CCAvenue のダッシュボードから返金するよう促されます。

CCAvenue 決済ブロック

注文ページには CCAvenue payment ブロックが表示されます。CCAvenue 注文 ID、トラッキング ID、ステータス、銀行参照番号、決済モード、カード名、送信金額と受取金額、日付と CCAvenue のメッセージが含まれます。テスト決済には Test mode バッジが表示されます。CCAvenue のメモは注文の非公開メッセージであり、管理画面でのみ表示されます。

返金

PrestaShop からの返金はサポートされていません。CCAvenue のダッシュボードで決済を返金し、その後、PrestaShop で手動で返金を記録してください。

ライセンスキー

本モジュールは、vibefox.net から取得した VibeFox ライセンスキーで動作します。License — VibeFox CCAvenue Payment のライセンスブロックは、Modules > Module Manager > VibeFox CCAvenue Payment > Configure ページの最上部、設定より上にあります。キーを License key に貼り付けて Activate をクリックしてください。その後、ブロックにはキーが伏せ字で表示され、ステータス（ライセンスの有効期限日、ドメインなど）と、ステータスを再確認する Check now、別のキーを入力する Change key、このショップからキーを削除する Remove key のボタンが表示されます。その下には Product: presta-payment-ccavenue の行と、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 のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで購入者に CCAvenue は表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ストアのフロントエンドはバックオフィスにログインしていることを認識しないため、この支払い方法はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブに通知が表示されます。既存の注文には影響しません。すでに開始された支払いは、購入者が CCAvenue から戻ったときに引き続き確認されます。

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

トラブルシューティング

チェックアウトに CCAvenue が表示されない：ライセンスが有効であること、Enable/Disable がオンであること、そして 3 つの認証情報がすべて入力されていることを確認してください：Merchant ID、Access Code、Working Key。いずれかが不足している場合、設定ページに警告が表示されます。Payment > Preferences で、カートの通貨、購入者の国、購入者のグループに対してモジュールが許可されているかを確認してください。

決済は完了したが、注文が作成されなかった：購入者が、ブラウザーを閉じたなどの理由で CCAvenue からストアに戻らなかった可能性があります。本モジュールにはサーバー間の通知はありません。CCAvenue のダッシュボードで決済を確認し、注文を手動で作成するか更新してください。

すべての決済が We could not confirm the payment result で終わる：応答を復号できません。Working Key が誤っている、別のドメインのものである、または余分な文字が含まれたままコピーされた可能性があります。このストアのドメイン向けにキーを生成し、貼り付け直してください。Debug log をオンにし、モジュールのページにある Log フィールドを確認してください。

決済ページの前に CCAvenue がエラーを表示する：Access Code と Working Key がこのドメイン向けに生成されていること、Return URL が CCAvenue に登録されたドメインに属していること、そしてテストモードでは CCAvenue がアカウントに対してテストアクセスを有効にしていることを確認してください。INR 以外の通貨の場合は、CCAvenue アカウントでマルチカレンシー処理が有効になっている必要があります。

購入者に This payment method is temporarily unavailable と表示される：認証情報のいずれかが不足しているか、カートの合計がゼロです。Debug log に理由が表示されます。

購入者に This payment method is not available と表示される：モジュールが無効になっているか、Payment > Preferences でカートの通貨、国、または顧客グループに対して許可されていません。

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

保存しても Merchant ID が変わらない：値に数字以外の文字が含まれています。Merchant ID の数字のみを入力してください。

注文が CCAvenue payment on hold または Awaiting CCAvenue payment になっている：注文のメモを確認してください（注文ステータスを参照）。CCAvenue のダッシュボードで決済を確認し、その後に注文を処理するか、決済を返金してください。

開発者向けに、本モジュールはフック actionCcavenueRequestParams を提供しています（暗号化の前に CCAvenue へ送信されるデータを変更できます。例：merchant_param2 から merchant_param5。値に & を含めてはいけません。amount、currency、order_id、merchant_param1 は変更しないでください）。

アンインストール

Modules > Module Manager に移動し、VibeFox CCAvenue Payment の横にあるメニューを開いて、Uninstall を選択します。このモジュールのライセンスキーとライセンスステータスは、常に削除されます。確認画面には、Delete data on uninstall がオンでない限り、設定と CCAvenue の参照情報は保持されることが表示されます。オンの場合、モジュールの設定、ログ、CCAvenue の注文参照が削除されます。オフの場合、後日再インストールできるようにすべてが保持されます。注文ステータス Awaiting CCAvenue payment と CCAvenue payment on hold は常に保持されます。既存の注文は、決済メモと取引 ID をそのまま保持します。

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