VibeFox Cardcom for PrestaShop — ヘルプ
要件
PrestaShop:8.0 から 9.x。
PHP:8.0 以降。古いバージョンの PHP ではモジュールのインストールを拒否します。
HTTPS:Cardcom が決済通知を送信できるよう、ショップは HTTPS でインターネットからアクセスできる必要があります。
通貨:カートの通貨は ILS、USD、EUR、GBP のいずれかである必要があります。それ以外の通貨の場合、チェックアウトで決済方法は表示されません。
Cardcom アカウント:実際の決済には、ターミナル番号、API ユーザー名、API パスワードを持つ Cardcom の加盟店アカウントが必要です。決済にはターミナル番号と API ユーザー名のみが必要です。API パスワードは、PrestaShop からの返金にのみ使用されます。テストモードは Cardcom アカウントがなくても利用できます。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。
インストール
1. 管理画面で Modules > Module Manager に進み、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックするか、後でモジュール一覧から VibeFox Cardcom Payment Gateway を見つけて Configure をクリックします。
3. Configure ページ上部のライセンスブロックの License key に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーの項を参照)。
4. Enable/Disable をオンにし、Test Mode はオンのままにして Save をクリックします。カード 4580 0000 0000 0000、任意の未来の有効期限、CVV 123 でテスト注文を行います。
5. 実際の決済を行うには、Test Mode をオフにし、Cardcom から受け取った Terminal Number、API Username、API Password を入力して Save をクリックします。
インストール時に、モジュールは注文ステータス Cardcom payment on hold を作成します。PrestaShop は、すべての通貨、国、顧客グループ向けの新しい決済モジュールを提供します。これらは Payment > Preferences で制限できます。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Cardcom Payment Gateway > Configure。各セクションには独自の Save ボタンがあり、ページ全体を保存します。テストモードがオンの間、ページは入力欄の上に警告を表示します。本番モードでは、ターミナル番号または API ユーザー名が未入力の場合(この場合、チェックアウトで Cardcom は非表示になります)、本番用の入力欄に公開テストターミナル 1000 / CardTest1994 が入っている場合(実際の料金が請求されないため、この場合もチェックアウトで Cardcom は非表示になります)に警告し、API パスワードがないと PrestaShop からの返金はできないことを通知します。ショップのデフォルト通貨がサポートされていない場合も警告します。認証情報が未入力またはテスト用の状態で本番モードを保存すると、自分のターミナル番号と API ユーザー名を入力するまで、チェックアウトでゲートウェイが非表示のままになることを示すエラーメッセージが表示されます。
Cardcom
Enable/Disable:Enable Cardcom Payment Gateway は決済方法をオンまたはオフにします。デフォルト:オフ。
Title:チェックアウトで購入者に表示される決済方法の名称です。注文に保存される決済方法名にもなります。デフォルト:Credit Card (Cardcom)。必須。
Description:チェックアウトで決済方法の下に表示されるテキストです。デフォルト:Pay securely with your credit card via Cardcom.
テストモード
テストモードは公開の Cardcom テストターミナル 1000(API ユーザー CardTest1994)を使用します。実際の料金は請求されず、Cardcom アカウントも不要です。テストカード:4580 0000 0000 0000、任意の未来の有効期限、CVV 123。テストモードでは、チェックアウトにもこのテストカードを示す行が表示されます。
Test Mode:テストモード(ターミナル 1000、実際の料金なし)を有効にします。デフォルト:オン。下の本番用認証情報で実際の決済を受け付けるにはオフにします。返金は、常に注文が支払われたモードの認証情報で送信されます。
本番用認証情報
ターミナル番号、API ユーザー名、API パスワードは、加盟店アカウントとともに Cardcom から提供されます。Cardcom の管理画面の API 設定、または Cardcom サポートから入手できます。これらの入力欄は本番モードでのみ使用されます。
Terminal Number:Cardcom のターミナル番号です。数字のみを含める必要があります。それ以外を入力するとエラーが表示され、以前の値が保持されます。
API Username:このターミナルの Cardcom API ユーザー名(ApiName)です。保存時にスペースは削除されます。
API Password:Cardcom の API パスワードです。PrestaShop からの返金にのみ必要です。保存済みのパスワードは再表示されません。入力欄は空のままで、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
Clear the saved API password:チェックボックスをオンにして Save をクリックすると、パスワードを削除します。入力欄が空の場合は、保存済みの値が保持されます。
決済ページ
Notification URL:Cardcom は決済通知(IndicatorUrl)をこのアドレスに送信します。フレンドリー URL を使用している場合は、https://your-shop/module/wcp_cardcom_payment_gateway/webhook のような形になり、/en/ などの言語コードが付くことがあります。このアドレスは、カート ID とともに各決済で自動的に Cardcom に渡されるため、Cardcom 側で設定する必要はありません。HTTPS でインターネットからアクセスできる必要があります。
Operation:Cardcom の決済ページで行われる処理です。
Max Installments:購入者が Cardcom のページで選べる分割払いの回数(支払い回数)の上限で、1 から 36 の範囲です。1 は分割払いなしを意味します。デフォルト:1。
Success Order Status:決済確認後の注文ステータスです。注文はこのステータスで直接作成されます。
注文と一致しない決済は、常に Cardcom payment on hold になります。
詳細設定
Debug log:API リクエストと通知を、モジュールフォルダー内の logs/cardcom_p_debug.log.php に記録します。このファイルは Web から開くことはできません。エラーは常に記録されます。認証情報、カードトークン、カード名義人の詳細は記録されません。デフォルト:オフ。
Log:ログのサイズと最新のエントリを表示します。Clear log をクリックすると空になります。
Delete on Uninstall:オンの場合、モジュールをアンインストールすると、設定とログが完全に削除されます。注文、Cardcom の取引と返金、Cardcom payment on hold の注文ステータスは常に保持されるため、再インストール後も古い注文は返金できます。デフォルト:オフ。
チェックアウト
決済ステップで、購入者は決済方法(デフォルトは Credit Card (Cardcom))を選び、You will be redirected to the secure Cardcom payment page. という注記を確認します。確定後、モジュールはカートの通貨でカート合計額について Cardcom の決済ページを作成し、購入者をそこに移動させます。この時点ではまだ注文は存在しません。購入者の言語がヘブライ語の場合はヘブライ語で、それ以外の場合は英語で開きます。カート内の商品は商品名として Cardcom に渡されます。購入者はカード情報を入力し、分割払いが許可されている場合は支払い回数を選択します。
決済後、購入者は貴店に戻ります。注文は、Cardcom が決済を確認した後にのみ支払い済みとしてマークされます。Cardcom は通知アドレスを呼び出し、モジュールはその呼び出しから決済ページのコードのみを取得します。そのコードが、このカートについて貴店が発行したものであることを確認した上で、Cardcom にサーバー間で実際の結果を問い合わせます。通知が遅れて届いた場合も、購入者が戻ったときに同じ確認が行われます。注文はこの時点で作成され、購入者には標準の注文確認ページが表示され、Your payment with Cardcom has been received. と示されます。購入者が戻った時点で Cardcom がまだ決済を確認していない場合は、Payment confirmation ページに Your payment is being confirmed by Cardcom. You will receive an e-mail as soon as it is confirmed. と表示され、Check again ボタンが表示されます。通知が届き次第、注文が作成されます。
決済が完了しなかった場合、または Cardcom が決済を拒否した場合、購入者はチェックアウトに戻り、The card payment was not completed. Please try again or choose a different payment method. と表示されます。注文は作成されず、カートは保持されます。購入者は再試行できます。試行ごとに新しい Cardcom 決済ページが作成されます。同じカートの以前の決済ページで行われた支払いは引き続き認識され、以前のページでの拒否は新しい試行に影響しません。
Cardcom が決済ページを開けない場合、購入者はチェックアウトに留まり、Could not connect to Cardcom. Please try again in a moment. などの短いメッセージ、または Cardcom が決済ページを開けなかったという内容と Cardcom のコードを含むメッセージが表示され、別の決済方法を選ぶことができます。
通知は、ショップがメンテナンスモードの間も機能し、ショップの国別制限にはブロックされません。
本モジュールは、カード決済を Cardcom のページでのみ受け付けます。保存済みカードやワンクリック決済、定期購読には対応していません。保存済みトークンへの請求は行わず、Cardcom の請求書や領収書の設定はありません。Cardcom 経由の Bit、Apple Pay、Google Pay、PayPal はなく、iframe モードや後日キャプチャする取引にも対応していません。
注文と返金
注文ステータス
No order yet:購入者は Cardcom に移動したものの、まだ支払っていない、決済が拒否された、または Cardcom がまだ決済を確認していない状態です。カートのみが存在します。
Payment accepted, Delivered or Cardcom payment on hold:決済が確認されました。ステータスは Success Order Status に従います。決済は、Cardcom の取引(deal)番号をトランザクション ID として記録されます。注文のプライベートメッセージには、Cardcom の取引が表示され、Cardcom から提供される場合はカードの下 4 桁、請求書番号、分割払いの回数も表示されます。テスト決済には Test mode — no real money was charged. と表示されます。
Cardcom payment on hold after payment:Cardcom は、注文と一致しない決済を確認しました。たとえば、決済ページを開いた後にカートが変更された場合、または異なる金額や通貨が請求された場合です。メッセージでその旨が説明され、Cardcom ブロックには Needs review として表示されます。通貨が注文と一致する場合、決済は Cardcom が請求した金額で記録されます。Cardcom の管理画面で決済と注文を照合し、その後で注文を完了するか、決済を返金してください。
Refunded:モジュールを通じて決済が全額返金されました。
注文がすでにあるカートに対して 2 回目の成功した決済が届いた場合(たとえば、購入者が 2 つのブラウザータブで支払った場合)、注文は変更されません。購入者に二重請求された可能性があることを警告するメッセージが表示され、Cardcom の管理画面で返金するよう求められます。
Cardcom 決済ブロック
注文ページには Cardcom payment ブロックが表示され、取引、決済ページのコード、ステータス、カード、分割払い、請求書、カードトークン(Charge + Save token の場合)、請求額、注文合計額、返金額、テスト決済の Test mode バッジ、返金履歴が含まれます。
返金
Cardcom payment ブロックで金額を入力します(まだ返金されていない金額が自動入力されます)。必要に応じて理由を入力し、Refund via Cardcom をクリックします。Refund this amount through Cardcom? This cannot be undone. という確認に対して承認してください。全額返金と一部返金に対応しており、1 つの注文に対して複数回の一部返金を行うことができます。注文を編集する権限が必要です。モジュールページへのアクセス権は必要ありません。返金は Cardcom が請求した金額と通貨で行われるため、金額や通貨の不一致が生じた後は、注文合計額ではなく、購入者が実際に支払った金額までを返金できます。返金は、注文が支払われたモードの認証情報で送信されます。テストモードに戻した後でも、テスト注文は Cardcom のテストターミナルで返金され、本番注文は常に本番の認証情報を使用します。本番での返金には API Username と API Password が必要です。Cardcom が返金を受け付けない場合、ブロックにエラーが表示され、返金は記録されません。成功した返金は、Cardcom の返金取引と理由とともに、返金履歴と注文メッセージに追加されます。全額返金を行うと、注文は Refunded になります。一部返金ではステータスは変わりません。
モジュールはクレジットメモを作成しません。注文ページの標準の PrestaShop の返金ボタンでは、Cardcom を通じて返金されません。Cardcom の管理画面で行われた返金は、ショップに報告されません。
ライセンスキー
モジュールは vibefox.net で入手した VibeFox ライセンスキーで動作します。License — VibeFox Cardcom Payment Gateway ライセンスブロックは、Modules > Module Manager > VibeFox Cardcom Payment Gateway > Configure ページの最初のブロックで、設定の上にあります。キーを License key に貼り付け、Activate をクリックします。その後、ブロックにはキーがマスク表示され、ステータス(例:ライセンスの有効期限日とドメイン)と、Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)のボタンが表示されます。その下には Product: presta-payment-cardcom の行と、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 アカウントで枠を解放してください。
有効なキーがない場合、チェックアウトで Cardcom は購入者に表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。PrestaShop のストアフロントは、管理画面にログインしていることを認識しないため、決済方法はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。すでに開始された決済は引き続き確認され、返金も機能します。
ライセンスが期限切れになると、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。管理画面で作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Cardcom が表示されない:ライセンスが有効であること、Enable/Disable がオンであること、カートの通貨が ILS、USD、EUR、GBP のいずれかであることを確認してください。本番モードでは、Terminal Number と API Username に、テストターミナル 1000 / CardTest1994 ではなく、ご自身の認証情報が入力されていることを確認してください。設定ページには、何かが不足している場合に警告が表示されます。Payment > Preferences で、カートの通貨、購入者の国、購入者のグループに対してモジュールが許可されていることを確認してください。
決済は完了したが、注文が作成されていない:ファイアウォール、パスワード保護、ローカルの開発サイトなどが原因で、Cardcom が貴店に到達できなかった可能性があります。通知アドレスは、HTTPS でインターネットからアクセスできる必要があります。注文は、購入者が決済後に貴店に戻ったときにも作成されます。Debug log をオンにして、モジュールページの Log 欄を確認してください。
通知の応答が Missing or invalid lowprofilecode or Unknown lowprofilecode for this order:この呼び出しには、貴店がこのカートについて発行した決済ページのコードが含まれていませんでした。何も変更されません。
通知の応答が Gateway not configured or Indicator check failed:決済ページが作成されたモードの認証情報がないか、確認のために Cardcom に接続できませんでした。何も変更されません。購入者が貴店に戻ったときに、決済が再確認されます。
通知の応答が Busy, retry:同じカートが別のリクエストによって確認中だったか、注文を作成できませんでした(たとえば、モジュールが無効になっていた)。理由を確認するには Debug log をオンにしてください。
通知の応答が ReturnValue mismatch or Terminal mismatch:Cardcom が、別のカートまたは別のターミナルに対する決済を報告しました。何も変更されません。Terminal Number がお使いのアカウントのターミナルであることを確認してください。
購入者に Payment error: this currency is not supported by Cardcom. と表示される:カートの通貨が ILS、USD、EUR、GBP のいずれでもありません。
購入者に Card payment is temporarily unavailable. Please choose another payment method. と表示される:本番モードがオンですが、ターミナル番号または API ユーザー名が未入力か、本番用の入力欄に公開テストターミナルが入っています。
購入者が Cardcom を選択するとエラーが表示される:Debug log をオンにして、Log 欄を確認してください。接続の問題や Cardcom のエラーコードが記録されています。
注文が支払い後に Cardcom payment on hold になっている:注文メッセージ、または Cardcom payment ブロックの Needs review を確認してください。支払われた金額または通貨が注文と異なっていました。注文を完了するか、決済を返金してください。
返金が API username and API password are required for refunds で失敗する:設定で API Password(および API Username)を入力してから、もう一度お試しください。
返金が Could not connect to Cardcom で失敗する:返金が行われたかどうかわからないため、再試行する前に Cardcom の管理画面を確認してください。
開発者向けに、README には、通貨の一覧を拡張するフック actionCardcomSupportedCurrencies(Cardcom ターミナルで有効になっている通貨のみを追加してください)と、決済ページのパラメーターを変更するフック actionCardcomLowProfileParams が記載されています。
アンインストール
Modules > Module Manager に進み、VibeFox Cardcom Payment Gateway の横にあるメニューを開き、Uninstall を選択します。このモジュールのライセンスキーとライセンスステータスは常に削除されます。Delete on Uninstall がオンの場合、設定とログは削除されます。オフの場合、後で再インストールするためにすべての設定が保持されます。Cardcom の取引と返金、および Cardcom payment on hold の注文ステータスは常に保持されるため、以前に支払われた注文は再インストール後も返金できます。既存の注文は、決済メッセージと取引 ID を保持します。
Cardcom は、各所有者の商標です。本モジュールは Cardcom と提携しておらず、Cardcom による承認も受けていません。
