VibeFox GMO for WooCommerce — ヘルプ
要件
WordPress: 6.0 以降。
WooCommerce: 8.0 以降がインストールされ、有効であること。これがない場合、プラグインは有効化できません。
PHP: 8.0 以降。
ストアの通貨: 日本円(JPY)。ストアの通貨が異なる場合、チェックアウトでは決済方法を表示しません。Pay for order ページでは注文の通貨で判定します。
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. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_gmo_payment フォルダーを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます。WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card > Manage に移動するか、プラグイン一覧ページでプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンス欄に VibeFox ライセンスキーを入力し、Activate をクリックします。
5. テスト環境および/または本番環境の Shop ID、Shop password、Config ID を入力し、Environment を選択します。
6. GMO-PG のショップ管理画面で 結果通知(結果の通知)を有効にし、設定に表示される通知 URL を登録します(「設定」を参照)。
7. Enable/Disable を有効にします。テスト環境でテスト決済を行った後、Environment を本番に切り替えます。
設定
すべての設定は WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card の一つのページにあります。ページタイトルには、現在の環境を示す TEST または PRODUCTION のバッジが表示されます。ストアの通貨が JPY でない場合や、現在の環境の Shop ID、Shop password、Config ID が不足している場合は、入力欄の上に警告が表示されます。いずれの場合も、チェックアウトでは決済方法を表示しません。決済方法一覧では、現在の環境の認証情報が揃うまで、ゲートウェイに設定が必要と表示されます。保存時に認証情報の前後の空白は削除されます。
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 の環境。
本番用認証情報(p01.mul-pay.jp)
Production Shop ID: 本番環境の Shop ID。
Production Shop password: 本番環境の Shop password。
Production Config ID: GMO-PG の管理画面で登録した Link Type Plus の設定 ID(設定ID)。
テスト用認証情報(pt01.mul-pay.jp)
Test Shop ID: テスト環境の Shop ID。
Test Shop password: テスト環境の Shop password。
Test Config ID: テスト環境の Link Type Plus の設定 ID(設定ID)。
決済
Capture: カードに請求するタイミング。
Order status after payment: 支払い済み注文のステータス。即座に設定され、ステータス変更と購入者へのメール送信はそれぞれ一回だけ行われます。
決済通知(結果通知)
結果通知は、決済が行われたことを貴店に知らせます。必須の設定です。GMO-PG のショップ管理画面で 結果通知(結果の通知)を有効にし、この設定セクションに表示される通知 URL を登録してください。URL は https://your-site/wc-api/gmo_pg_webhook/ のような形式です。設定に表示された URL をそのまま正確にコピーしてください。
GMO-PG の通知には署名がないため、プラグインはその内容をそのまま信頼しません。通知は、設定済みのいずれかの Shop ID から送られ、注文の支払い時と同じ環境でこのストアが作成した決済に関するものでなければなりません。そのうえで、プラグインは Shop password を使って GMO-PG に取引を照会し(SearchTrade)、その応答のみに基づいて注文を変更します。実在する取引と一致しない通知は何も変更しません。GMO-PG の管理画面で行った取引など、ストアが作成していない取引は、受信確認の応答を返したうえで無視します。通知を確認できない場合は、GMO-PG が再送する応答を返します(GMO-PG は最大 5 回再試行します)。
通知がない場合、注文が確定するのは、支払い後に購入者がストアに戻ったときだけです。
詳細設定
Debug log: Log API requests and notifications により、WooCommerce > Status > Logs にソース wcp_gmo_payment として記録します。エラーは常に記録されます。パスワードと購入者データはマスクされます。初期値: オフ。
Delete data on uninstall: Delete the gateway settings and logs when the plugin is deleted。無効化では何も削除しません。注文データ(取引 ID)は常に保持されます。初期値: オフ。
チェックアウト
購入者が決済方法(初期値は Credit card)を選んで注文します。プラグインは注文合計額を整数の円単位に丸めて GMO-PG Link Type Plus の決済を作成し、購入者を GMO-PG の決済ページへ送ります。購入者はそこでクレジットカードで支払います。3-D Secure 2.0 は GMO-PG が処理し、3-D Secure のために購入者の請求先メールアドレスを GMO-PG に渡します。決済ページはサイトの言語に応じて日本語、中国語、英語で開きます。GMO-PG では決済に WC- と注文番号が表示されます。その他の購入者データは送信しません。
支払い後、購入者は貴店に戻ります。署名付き結果を Shop password で検証し、GMO-PG の確認後にのみ注文を支払い済みにします。確認は、購入者が戻った際のサーバー側 SearchTrade リクエスト、または結果通知で行います。両方とも同じ処理ロジックを使うため、注文を二重に処理することはありません。決済が未確認の場合、注文受付ページに Your card payment is being confirmed by GMO Payment Gateway. You will receive an e-mail as soon as it is confirmed. と表示されます。
カードが拒否された場合や GMO-PG ページで決済に失敗した場合、注文は失敗となり、購入者は Pay for order ページに移動して 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. などの短いメッセージを表示し、注文メモに理由を追加します。
この決済方法は、クラシックチェックアウト、カートおよびチェックアウトブロック、Pay for order ページで利用できます。チェックアウトブロックにはカードアイコンと説明が表示されます。テスト環境では、クラシックチェックアウトとチェックアウトブロックの両方に Test mode — no real charge のバッジを表示します。WooCommerce の高パフォーマンス注文ストレージ(HPOS)に対応しています。
本プラグインは JPY のクレジットカード決済のみに対応し、常に GMO-PG ページで決済します。その他の GMO-PG 決済手段、複数通貨、保存済みカードや GMO-PG 会員登録、定期購入や継続課金、サイト内のカード入力フォームには対応していません。
注文と返金
注文ステータス
Pending payment: 購入者が GMO-PG に移動した後、まだ支払っていないか、GMO-PG がまだ決済を確認していません。
Processing or Completed: 決済が確認されました。ステータスは Order status after payment に従います。注文メモには、金額、GMO-PG のステータス、取引、確認方法(通知または購入者の戻り)が表示されます。取引 ID は GMO-PG の TranID です。
On hold (authorized): Authorize only (仮売上) で金額が承認されました。承認の有効期限が切れる前に、注文操作 Capture payment (GMO-PG) または GMO-PG の管理画面でキャプチャしてください。キャプチャ後、注文は処理中または完了になります。GMO-PG で承認を取り消すと、注文もキャンセルされます。
On hold after payment: GMO-PG が注文合計とは異なる金額を報告したか、注文のキャンセル後に決済が届きました。注文メモに説明があります。注文を確認して履行するか、返金してください。
Failed: カードが拒否されたか、GMO-PG ページで決済が完了しませんでした。
支払い済みまたは終了した注文に二度目の決済が届いても、注文は変更しません。GMO-PG の管理画面で重複分を返金するよう、メモで案内します。
キャプチャ
注文操作 Capture payment (GMO-PG) は、承認のみを行った保留中の注文に表示されます。承認済み金額を請求します。GMO-PG の管理画面ですでにキャプチャした場合など、取引が承認状態でなくなっているときは、現在のステータスをメモに追加し、その状態に従って処理します。
返金
注文を開いて Refund をクリックし、金額を入力して Refund via Credit card をクリックします(ボタンには設定した Title が表示されます)。整数の円単位で全額返金と一部返金に対応します。残額全額を返金すると GMO-PG の取引を取り消し、取消か返品かは GMO-PG が判断します。一部返金では取引金額を減額し、カード会社が新しい金額を承認します。返金は注文の支払い時と同じ環境に送信するため、その環境の Shop ID と Shop password の設定が必要です。GMO-PG が返金を受け付けない場合、WooCommerce にエラーを表示し、返金は記録しません。成功した返金は注文メモに追加します。
GMO-PG の管理画面で行った返金や取消は結果通知で受信し、注文メモに追加します。WooCommerce の返金としては自動記録されません。必要に応じて、GMO-PG のボタンを使わずに WooCommerce で手動返金を作成してください。
ライセンスキー
本プラグインは vibefox.net の VibeFox ライセンスキーで動作します。ライセンス欄は WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card の上部にあります。License key にキーを貼り付け、Activate をクリックしてください。この欄には、ライセンスの有効期限やドメインなどの状態が表示されます。Check now で状態を再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除できます。Manage licenses and domains in your account リンクから vibefox.net アカウントを開けます。
一つのキーを一つのドメインで使用できます。サイトからキーを削除しても、ドメインの登録枠は解放されません。vibefox.net アカウントで枠を解放してください。
有効なキーがない場合、購入者のチェックアウトには決済方法を表示しません。それでも決済を開始した場合、購入者には This payment method is not available. Please choose another one. と表示します。ログイン中のストア管理者には (unlicensed — visible to admins only) と表示した決済方法が引き続き見えるため、キーを購入する前にプラグインを設定してテストできます。プラグイン一覧と WooCommerce のページに案内を表示します。既存の注文には影響せず、開始済みの決済は引き続き確認され、返金やキャプチャも機能します。
ライセンスの有効期限が切れてもプラグインは動作し続けますが、更新とサポートにはライセンスの更新が必要です。状態はバックグラウンドで自動的に再確認されます。
トラブルシューティング
チェックアウトにクレジットカードが表示されない: ライセンスが有効で、Enable/Disable がオン、ストアの通貨が JPY、現在の環境の Shop ID、Shop password、Config ID が設定済みであることを確認してください。9,999,999 JPY を超える注文はカードで支払えません。通貨や認証情報に問題があると、設定ページに警告が表示されます。
決済は成功したが注文が Pending payment のまま: 結果通知が機能していません。使用中の環境の GMO-PG ショップ管理画面で、結果通知 が有効で、URL が設定に表示されたものと完全に一致することを確認してください。プラグインは各通知を検証するため、その環境の Shop ID と Shop password が入力済みであることも確認してください。Debug log を有効にして WooCommerce > Status > Logs のソース wcp_gmo_payment を確認します。購入者が支払い後にストアに戻った場合にも、注文は確定されます。
ログに Notification rejected: unknown ShopID と表示される: 設定に Shop ID がないショップからの通知です。その環境の Shop ID を入力してください。
ログに Notification ignored ... is not a payment of this store と表示される: GMO-PG の管理画面で行った場合など、このストアが作成していない取引です。対応は不要です。
別の環境で注文が支払われたとログに表示される: テスト決済と本番決済は分離されています。テスト通知で本番注文を確定することはなく、その逆もありません。
注文時に購入者にエラーが表示される: 注文メモを開くか Debug log を有効にしてください。メモには GMO-PG のエラーコード(ErrCode、ErrInfo)が表示されます。通常は Shop ID、Shop password、Config ID の誤りが原因です。GMO Payment Gateway accepts payments in Japanese Yen (JPY) only. は、注文の通貨が JPY ではないことを意味します。
支払い後も注文が On hold になる: 注文メモを確認してください。承認のみでキャプチャ待ち、支払額と注文金額の不一致、または注文キャンセル後の入金が原因です。
返金に失敗する: メッセージを確認してください。Shop ID とパスワードが未設定の別環境で支払われた注文、GMO-PG で取消済みの取引、または取引の残額を超える金額が考えられます。
ライセンス欄にエラーが表示される: 欄内のメッセージに従ってください。たとえば、キーが別ドメインで使用済みの場合は、vibefox.net アカウントで枠を解放し、Check now をクリックします。サイトのアドレスが変わった場合は、Check now をクリックして新ドメインでキーを有効にします。ライセンスサーバーに接続できない場合、プラグインは最後に確認できた状態で動作を続けます。
アンインストール
プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページで無効化してから削除してください。このプラグインのライセンスキーとライセンス状態は常に削除されます。ゲートウェイの設定とログは、Delete data on uninstall がオンだった場合にのみ削除します。オフの場合は再インストールに備えて保持します。注文に保存された GMO-PG データは決済履歴のため、常に保持されます。既存の注文の決済メモと取引 ID も保持されます。
GMO Payment Gateway は、それぞれの所有者の商標です。本プラグインは GMO Payment Gateway と提携しておらず、GMO Payment Gateway の推奨を受けていません。
