戻る

VibeFox GMO for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 から 9.x。

PHP: 8.0 以降。モジュールは、それより古い PHP バージョンではインストールを拒否します。

通貨: 日本円(JPY)。GMO-PG は円のみで請求するため、カートの通貨が JPY の場合にのみ決済手段が表示されます。ストアにまだ JPY がない場合は、International > Localization > Currencies で追加してください。

GMO Payment Gateway アカウント: Link Type Plus を利用できる GMO-PG の加盟店契約。テスト環境および/または本番環境の Shop ID、Shop password、Link Type Plus の Config ID(設定ID)が必要です。また、GMO-PG の店舗管理画面で結果通知(結果通知)を有効にしておく必要があります(設定を参照)。Site ID と Site password は使用しません。

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

インストール

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

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

3. Configure ページ上部のライセンスブロックの License key に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。

4. テスト環境および/または本番環境の Shop ID、Shop password、Config ID を入力し、Environment を選択します。

5. GMO-PG の店舗管理画面で 結果通知(結果通知)を有効にし、設定に表示される通知 URL を登録します(設定を参照)。

6. Enable/Disable を有効にして Save をクリックします。テスト環境でテスト決済を行い、その後 Environment を本番に切り替えます。

インストール時に、モジュールは注文ステータス GMO-PG payment on hold を作成します。PrestaShop は、すべての通貨、国、顧客グループに対して新しい決済モジュールを提供します。これらは Payment > Preferences で制限できますが、JPY は許可したままにしてください。

設定

すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox GMO Payment Gateway > Configure。どの Save ボタンも、ページ全体を保存します。項目の上には、ストアの既定通貨が JPY でない場合や、現在の環境の Shop ID、Shop password、Config ID が未入力の場合に警告が表示されます(その場合、チェックアウトで決済手段は非表示になります)。また、有効な環境も表示されます:TEST — payments go to pt01.mul-pay.jp with the test credentials, no real money is charged. または PRODUCTION — payments go to p01.mul-pay.jp.。認証情報の前後の空白は、保存時に削除されます。

GMO Payment Gateway — Credit Card

Enable/Disable: Enable GMO Payment Gateway — Credit Card で決済手段のオン・オフを切り替えます。既定値:オフ。

Title: チェックアウトで表示される決済手段の名前です。注文にも、この名前が決済手段名として保存されます。既定値:Credit card。必須。

Description: チェックアウトで決済手段の下に表示されるテキストです。既定値:You will be redirected to the secure GMO Payment Gateway page to pay by credit card.

GMO-PG アカウント

Shop ID と Shop password は GMO-PG の店舗管理画面の Shop management > Shop information にあります。Config ID は Link Type Plus > Settings(設定ID)にあります。テスト環境と本番環境では認証情報が異なります。

Environment: 新しい決済を受け付ける GMO-PG 環境です。

Test (sandbox): テスト用の認証情報で pt01.mul-pay.jp を使用します(既定)。
Production (live): 本番用の認証情報で p01.mul-pay.jp を使用します。

Production Shop ID: 本番環境の Shop ID です。

Production Shop password: 本番環境の Shop password です。

Production Config ID: GMO-PG の管理画面に登録された Link Type Plus の Config ID(設定ID)です。

Test Shop ID: テスト環境の Shop ID です。

Test Shop password: テスト環境の Shop password です。

Test Config ID: テスト環境の Link Type Plus の Config ID(設定ID)です。

保存済みのパスワードは再表示されません。項目は空のままで、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。

Clear saved passwords: パスワードにチェックを入れて Save をクリックすると、削除されます。項目が空のままであれば、保存済みの値は維持されます。

Payment

Capture: カードに請求するタイミングです。

Capture immediately (即時売上): カードにすぐ請求します(既定)。
Authorize only (仮売上): 金額は承認のみ行われ、注文は GMO-PG payment on hold になります。承認が期限切れになる前に、注文画面または GMO-PG の管理画面で Capture payment (GMO-PG) によりキャプチャするまで保留されます。

Order status after payment: 支払い済みの注文のステータスです。

Processing: 注文は Payment accepted になります(既定)。
Completed: 注文は Delivered になります。仮想商品やダウンロード商品に適しています。

決済通知(結果通知)

結果通知は、決済が行われたことをストアに知らせます。必須です。GMO-PG の管理画面で 結果通知(結果通知)を有効にし、このセクションの Notification URL に表示される URL を設定してください。フレンドリー URL を使用している場合は、https://your-shop/module/wcp_gmo_payment/notify のような形式になり、/ja/ のような言語コードが付くこともあります。URL は設定に表示されたとおりに正確にコピーしてください。インターネットからアクセスできる必要があります。メンテナンスモードでもブロックされません。

GMO-PG の通知には署名がないため、モジュールは通知の内容を信頼しません。通知は設定済みの Shop ID のいずれかから届き、決済が行われた環境で、このストアが作成した決済を参照している必要があります。その後、モジュールは Shop password を使って GMO-PG に取引を照会し(SearchTrade)、その応答に基づいてのみカートや注文を変更します。実在する取引と一致しない通知は、何も変更しません。GMO-PG の管理画面で行われた取引など、ストアが作成していない取引は確認されたうえで無視されます。モジュールが通知を検証できない場合は、GMO-PG が再送するように応答します(GMO-PG は最大 5 回再試行します)。

通知がない場合、注文は、購入者が決済後にストアへ戻ったときにのみ作成されます。

Advanced

Debug log: API リクエストと通知を、モジュールのフォルダにある logs/gmo_pg_debug.log.php に書き込みます。このファイルは Web から開くことはできません。スイッチがオフのときでも、エラーは常に記録されます。パスワードと購入者データはマスクされます。既定値:オフ。

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

Delete data on uninstall: オンの場合、モジュールをアンインストールすると、ゲートウェイの設定とログが削除されます。注文データ(GMO OrderID、取引 ID)は常に保持されます。既定値:オフ。

チェックアウト

支払いステップで、購入者は決済手段(既定では Credit card)を選び、その説明を確認します。テスト環境では、その上に TEST — GMO-PG test environment, no real charges. のバッジが表示されます。確定すると、モジュールはカート合計額(整数の円に丸められます)で GMO-PG Link Type Plus の決済を作成し、購入者を GMO-PG の決済ページに移動させます。購入者はそこでクレジットカード決済を行います。3-D Secure 2.0 は GMO-PG が処理し、購入者のメールアドレスは 3-D Secure のために GMO-PG に渡されます。決済ページは、購入者の言語に応じて日本語、中国語、または英語で開きます。GMO-PG 上の決済には PS- とカート番号が表示されます。それ以外の購入者データは送信されません。この時点では、まだ注文は存在しません。

決済後、購入者はストアに戻ります。署名された結果は、決済が行われた環境の Shop password で検証され、注文は GMO-PG による確認の後にのみ支払い済みとしてマークされます。購入者が戻ったときのサーバー側の SearchTrade リクエスト、または結果通知によって確認されます。どちらも同じロジックを使うため、注文が二重に作成されることはありません。その後、購入者には標準の注文確認ページが表示されます。GMO-PG がまだ決済を確認していない場合は、Payment confirmation ページが表示されます。そこには Your card payment is being confirmed by GMO Payment Gateway. You will receive an e-mail as soon as it is confirmed. というメッセージと Check again ボタンがあります。通知が届いた時点で注文が作成されます。

カードが拒否された場合や、GMO-PG のページで決済が失敗した場合、購入者はチェックアウトに戻り、The card payment was declined or could not be completed. Please try again or use another card. と表示されます。購入者が決済せずに GMO-PG のページを離れた場合は、The payment was not completed. You can try again or choose another payment method. と表示されます。カートは保持されます。新たに試行するたびに、前の未払いの決済リンクは取り消されます。その間に前のリンクが支払われていた場合、注文はその決済から作成され、新しいリンクは作成されません。

カート合計額が 1 から 9,999,999 JPY の場合に決済できます。それを超える場合は、決済手段が非表示になります。決済を開始できない場合、購入者はチェックアウトに留まり、Card payment could not be started. Please try again or choose another payment method. などの短いメッセージが表示されます。理由はログに記録されます。

通知と戻りは、ストアがメンテナンスモードのときも機能し、ストアの国別制限の影響も受けません。

本モジュールは、クレジットカード決済を JPY でのみ受け付け、常に GMO-PG のページで行います。その他の GMO-PG 決済手段、複数通貨、保存済みカードや GMO-PG の会員登録、定期購入や継続課金には対応しておらず、サイト内のカード入力フォームもありません。

注文と返金

注文ステータス

まだ注文がない: 購入者は GMO-PG に移動したものの、まだ支払っていないか、GMO-PG がまだ決済を確認していません。カートのみが存在します。

Payment accepted または Delivered: 決済が確認されました。ステータスは Order status after payment に従います。決済は GMO-PG の TranID を取引 ID として記録され、メモには金額、GMO-PG のステータス、取引、確認方法(通知または戻り)が表示されます。

GMO-PG payment on hold(承認済み): Authorize only (仮売上) の場合、金額は承認されています。承認が期限切れになる前に、Capture payment (GMO-PG) または GMO-PG の管理画面でキャプチャしてください。キャプチャ後、注文は Payment accepted または Delivered になります。GMO-PG で承認が取り消された場合、注文は Canceled になります。

支払い後の GMO-PG payment on hold: GMO-PG が報告した金額がカート合計額と異なるか、カートが JPY ではありませんでした。メモにその理由が記載され、決済は GMO-PG が実際に徴収した金額で記録されます。注文を確認し、発送するか、決済を返金してください。

Refunded: モジュールを通じて決済が全額返金されました。一度もキャプチャされていない承認を全額返金すると、Canceled になります。

注文がすでに支払い済みまたはクローズされているカートに対して二回目の決済が届いた場合、注文は変更されません。メモで、重複した決済を GMO-PG の管理画面から返金するよう促されます。

GMO Payment Gateway ブロック

注文画面には GMO Payment Gateway ブロックが表示され、GMO OrderID、Transaction ID、ステータス(GMO-PG のステータスを含む)、Paid / refunded、テスト決済を示す TEST バッジ、返金履歴、注文の GMO-PG notes が含まれます。キャプチャと返金には注文を編集する権限が必要です。モジュールのページへのアクセス権は必要ありません。

キャプチャ

Capture payment (GMO-PG) は、承認のみが行われた保留中の注文のブロックに表示されます。Capture the authorized GMO-PG payment? を確認してください。モジュールは GMO-PG で取引を確認し、承認された金額を請求します。取引がもはや承認されていない場合(たとえば GMO-PG の管理画面ですでにキャプチャされている場合)は、メモに現在のステータスが表示され、注文もそれに従います。

返金

ブロックに金額を入力します(まだ返金されていない金額が自動入力されます)。必要に応じて理由を入力し、Refund via GMO-PG をクリックします。Refund this amount through GMO-PG? を確認してください。円単位の全額返金と一部返金に対応しています。上限は注文合計額ではなく、GMO-PG が実際に徴収し、まだ保持している金額です。残額をすべて返金すると、GMO-PG の取引はキャンセルされます。取消か返品かは GMO-PG が判断します。一部返金では、取引の金額が減ります。返金は決済が行われた環境に送信されるため、その環境の Shop ID と Shop password が設定されている必要があります。GMO-PG が返金を受け付けない場合は、ブロックにエラーが表示され、返金は記録されません。成功した返金は、返金履歴とメモに追加されます。全額返金では注文が Refunded になります。一部返金ではステータスは変わりません。

モジュールはクレジット伝票を作成しません。注文画面にある PrestaShop の標準の返金ボタンでは、GMO-PG を通じた返金は行われません。

GMO-PG の管理画面で行われた返金と取消は、結果通知によって届き、メモに追加されます。注文ステータスとクレジット伝票は、GMO-PG で取り消された承認の場合を除き、自動では変更されません。必要に応じて手動で更新してください。

ライセンスキー

モジュールは、vibefox.net で取得した VibeFox ライセンスキーを使用します。License — VibeFox GMO Payment Gateway のライセンスブロックは、Modules > Module Manager > VibeFox GMO Payment Gateway > Configure ページで設定の上にある最初のブロックです。キーを License key に入力し、Activate をクリックしてください。その後、ブロックにはキーがマスクされた状態、ステータス(ライセンスの有効期限日や、お使いのドメインなど)、そして、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: presta-payment-gmo の行と、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 と日付)。ストアの URL を変更した後や、アカウントでドメインの枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認できたステータスで動作を続けます。

1 つのキーは 1 つのドメインで使用できます。メインストアのドメインを指し、マルチストア構成でも同様です。ストアからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、GMO-PG のクレジットカード決済はチェックアウトで購入者に表示されません。それでも決済が開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。PrestaShop のストアフロントは、管理画面にログインしていることを認識しないため、決済手段はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。すでに開始された決済は引き続き確認され、キャプチャと返金も機能します。

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

トラブルシューティング

チェックアウトにクレジットカードが表示されない: ライセンスが有効であること、Enable/Disable がオンであること、カートの通貨が JPY であること、現在の環境に Shop ID、Shop password、Config ID が設定されていることを確認してください。9,999,999 JPY を超えるカート合計額はカードで決済できません。通貨または認証情報が誤っている場合、設定ページに警告が表示されます。Payment > Preferences で、モジュールが JPY、購入者の国、購入者のグループに対して許可されていることを確認してください。

決済は完了したが、注文が作成されなかった: 結果通知が機能していません。使用している環境の GMO-PG 店舗管理画面で、結果通知 が有効になっていること、URL が Notification URL に表示されたものと完全に一致していることを確認してください。モジュールは各通知をその環境の Shop ID と Shop password で検証するため、それらが入力されていることも確認してください。Debug log をオンにして、モジュールのページの Log 欄を確認してください。購入者が決済後にストアに戻った場合も、注文は作成されます。

ログに Notification rejected: unknown ShopID と表示される: 通知は、Shop ID が設定に含まれていない店舗から届きました。その環境の Shop ID を入力してください。

ログに Notification ignored: OrderID is not a payment of this store と表示される: この取引は、このストアが作成したものではありません。たとえば GMO-PG の管理画面で行われたものです。対応は不要です。

ログに、カートが別の環境で支払われたと表示される: テスト決済と本番決済は分けて扱われます。テストの通知が本番の決済を確定させることはなく、その逆もありません。

ログに Cannot create the order: the module is disabled と表示される: 決済を確定している最中にモジュールが無効化されていました。有効にしてください。GMO-PG が通知を再送します。

購入者がカード決済を選択するとエラーが表示される: Debug log をオンにし、Log 欄を確認してください。ログには GMO-PG のエラーコード(ErrCode、ErrInfo)が表示されます。Shop ID、Shop password、Config ID の誤りが典型的な原因です。GMO Payment Gateway accepts payments in Japanese Yen (JPY) only. は、カートが JPY ではないことを意味します。

注文が GMO-PG payment on hold になっている: GMO Payment Gateway ブロックのメモを確認してください。注文は承認のみされており、キャプチャを待っているか、支払われた金額がカートの金額と異なっていました。

返金またはキャプチャが失敗する: ブロックのメッセージを確認してください。注文が、Shop ID と Shop password が未設定の別の環境で支払われた可能性があります。取引が GMO-PG ですでに取り消されている可能性があります。または、金額が取引の残額を超えている可能性があります。The order is being updated by GMO-PG right now. Try again in a moment. は、通知が同時に処理されていたことを意味します。

ブロックに You do not have permission to refund orders. と表示される: 従業員プロフィールに注文を編集する権限がありません。管理者に権限の付与を依頼してください。

アンインストール

Modules > Module Manager に移動し、VibeFox GMO Payment Gateway の横のメニューを開いて Uninstall を選択します。ライセンスキーとこのモジュールのライセンス状態は、常に削除されます。Delete data on uninstall がオンの場合、ゲートウェイの設定とログが削除されます。オフの場合、後で再インストールできるように、すべての設定が保持されます。GMO-PG の取引と返金、および注文ステータス GMO-PG payment on hold は常に保持されるため、以前に支払われた注文は、再インストール後もキャプチャと返金が可能です。既存の注文は、支払いのメモと取引 ID を保持します。

GMO Payment Gateway は、それぞれの所有者の商標です。本モジュールは GMO Payment Gateway とは提携しておらず、同社による推奨も受けていません。