戻る

VibeFox PayMongo for WooCommerce — ヘルプ

動作要件

WordPress:6.0 以降。

WooCommerce:8.0 以降。インストールされ、有効化されている必要があります。WooCommerce がないとプラグインは有効化できません。

PHP:8.0 以降。

通貨:フィリピンペソ(PHP)。ストアの通貨、または Pay for order ページの注文通貨が PHP でない場合、この支払い方法は表示されません。

PayMongo アカウント:PayMongo アカウントの API シークレットキーと、モードごとのウェブフックが必要です(設定を参照)。使用されるのは、シークレットキー(sk_test_...、sk_live_...)と、ウェブフックの署名シークレット(whsk_...)だけです。支払いページは PayMongo がホストするため、公開キーは不要です。提供する支払い方法は、PayMongo アカウントで有効になっている必要があります。

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

インストール

1. WordPress で Plugins > Add New > Upload Plugin に進み、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_paymongo_payment_gateway フォルダを /wp-content/plugins/ にアップロードすることもできます。

2. Activate をクリックします。

3. 設定を開きます:WooCommerce > Settings > Payments > PayMongo > Manage。または、Plugins ページでプラグイン名の下にある Settings をクリックします。

4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。

5. PayMongo のシークレットキーを貼り付け、ウェブフックを作成し、その署名シークレットを貼り付けます(設定を参照)。

6. 支払い方法を選択し、Enable/Disable をオンにして保存します。Test mode をオンにして支払いをテストし、その後オフにします。

設定

すべての設定は 1 つのページにあります:WooCommerce > Settings > Payments > PayMongo。入力欄の上には、ストアの通貨が PHP でない場合、現在のモードにシークレットキーがない場合(その場合、チェックアウトに PayMongo は表示されません)、ウェブフックのシークレットがない場合(その場合、支払いは購入者が戻ったときにのみ確認されます)に警告が表示されます。テストモードがオンの間は、Test mode is on: no real payments are made. と表示されます。支払い方法の一覧では、現在のモードにシークレットキーが設定されるまで、PayMongo に設定が必要であることが示されます。

一般

Enable/Disable:Enable PayMongo で、この支払い方法のオン・オフを切り替えます。デフォルト:オフ。

Title:チェックアウトで購入者に表示される支払い方法の名前です。デフォルト:PayMongo (Card, GCash, GrabPay, Maya)。

Description:チェックアウトで支払い方法の下に表示されるテキストです。デフォルト:You will be redirected to PayMongo to pay securely with your card, GCash, GrabPay or Maya.

Payment methods:PayMongo の決済ページで提供される方法です。PayMongo アカウントで有効になっている方法のみを選択してください。そうしないと PayMongo が決済を拒否します。デフォルト:Cards, GCash, GrabPay and Maya。

Cards (Visa, Mastercard):3-D Secure は PayMongo が処理します。
GCash, GrabPay, Maya, ShopeePay:電子ウォレット。
QR Ph:QR コードによる支払い。
BillEase, Atome:今買って後で払う。
Direct online banking (BPI, UnionBank):銀行口座からの支払い。

API キー

シークレットキーは PayMongo Dashboard > Developers > API keys からコピーしてください。公開キーは不要です。各キーは想定されたプレフィックスで始まる必要があります。誤ったプレフィックスの値は保存されず、ページには must start with のフィールドにそのプレフィックスが必要であることと、The previous value was kept. が表示されます。

Test mode:Enable test mode (no real payments)。新しい支払いはテスト用キーを使用します。以前に行われた支払いは、その支払いが行われたモードを保持するため、ステータス確認と返金には対応するキーが使われます。デフォルト:オン。実際の支払いを受け付けるにはオフにします。

Test secret key:テストモードのシークレットキーです。sk_test_ で始まります。

Test webhook secret:テストモードのウェブフックの署名シークレットです。whsk_ で始まります。

Live secret key:本番モードのシークレットキーです。sk_live_ で始まります。

Live webhook secret:本番モードのウェブフックの署名シークレットです。whsk_ で始まります。

ウェブフック

ウェブフックは、購入者が支払い後にブラウザを閉じた場合でも、支払いが行われたことをストアに通知します。テストと本番のモードごとに、PayMongo ダッシュボード(または PayMongo API)でウェブフックを作成し、設定のこのセクションに表示される URL を使用してください。URL は https://your-site/?wc-api=paymongo_p_webhook のような形式です。

次のイベントを選択します:

checkout_session.payment.paid:購入者が PayMongo の決済ページで支払いました。
payment.paid:支払いが行われました。
payment.failed:支払いの試行が失敗しました。

各ウェブフックの署名シークレット(whsk_...)を Test webhook secret または Live webhook secret にコピーします。有効な署名のないウェブフックは拒否され、イベントのモードは署名のモードと一致している必要があります。すべてのイベントは、注文を変更する前に PayMongo API で再確認されます。PayMongo はアカウント全体のイベントを各ウェブフックに送信します。このストアが作成したのではない支払いのイベントは無視されます。ウェブフックがなければ、支払いは購入者がストアに戻ったときにのみ確認されます。

注文

支払い後の注文ステータス:支払いが成功した後に設定される注文ステータスです。ステータスはすぐに設定され、2 回目のステータス変更は行われません。

Processing:WooCommerce の標準(デフォルト)です。
Completed:配送が不要なバーチャル商品やダウンロード商品に適しています。

詳細設定

Debug log:Log API calls and webhook events をオンにすると、これらが WooCommerce > Status > Logs に、ソース wcp_paymongo_payment_gateway として書き込まれます。エラーは常に記録されます。キーや購入者データは記録されません。デフォルト:オフ。

Delete data on uninstall:Delete the settings and logs when the plugin is deleted。注文に保存された PayMongo の ID は、返金と経理に必要なため保持されます。デフォルト:オフ。

チェックアウト

購入者は支払い方法(デフォルトは PayMongo (Card, GCash, GrabPay, Maya))を選び、注文を確定します。テストモードでは、チェックアウトに Test mode: no real payment will be made. と表示されます。プラグインは、注文合計額について PHP 建ての PayMongo チェックアウトセッションを作成します。その中には Order # と注文番号の 1 行が含まれ、購入者は PayMongo の決済ページに移動します。購入者の氏名、メールアドレス、電話番号、請求先住所は PayMongo に渡されます。そこで購入者は、選択された方法のいずれかを選んで支払います。

この支払い方法は、₱100.00 以上の注文でのみ表示されます。それより少ない合計額は PayMongo で支払うことができません。

支払い後、購入者はストアの注文受付ページに戻ります。注文は、PayMongo が確認した後にのみ支払い済みになります。プラグインは、購入者が戻ったときと、ウェブフックが届いたときに、PayMongo API に支払いを問い合わせます。PayMongo がまだ支払いを処理中であったり、接続できなかったりする場合でも、購入者は注文受付ページに移動し、ウェブフックが後で注文を完了させます。

購入者が PayMongo のページでキャンセルしたり、支払いを完了しなかったりした場合、購入者は次のメッセージとともに Pay for order ページに移動します:You cancelled the PayMongo payment. You can try again or choose another payment method. または Your PayMongo payment was not completed. You can try again or choose another payment method. 注文は未払いのままです。新しい試行では、まず前回の試行を確認します。その間に支払いが完了していれば、新たに支払うことなく注文が完了します。そうでなければ、前回の PayMongo 決済リンクは期限切れになり、購入者が二重に支払うことはありません。前回の支払いがまだ処理中の間、購入者には Your previous PayMongo payment for this order is still being processed. Please wait a few minutes before trying again. と表示されます。

PayMongo が支払いを開始できない場合、購入者には短いメッセージが表示されます。たとえば The payment could not be started. Please try again or choose another payment method. や PayMongo could not be reached. Please try again in a moment. などです。技術的な理由は注文メモに追加されます。

この支払い方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce の高性能注文保存(HPOS)に対応しています。

プラグインは、PayMongo のページでの一回払いのみを扱います。お店の決済ページにカード入力欄はなく、保存済みカード、サブスクリプションや定期支払い、分割払い、オーソリとキャプチャの分離には対応していません。

注文と返金

注文ステータス

Pending payment:購入者は PayMongo に移動したものの、まだ支払っていないか、PayMongo がまだ支払いを確認していません。注文ごとに作成された PayMongo チェックアウトは、それぞれメモに記録されます。PayMongo が支払いを処理している間は、その旨がメモに記載されます。

Processing または Completed:支払いが確認されました。ステータスは Order status after payment に従います。注文メモには、PayMongo の支払い、金額、方法、モードが表示されます。取引 ID は PayMongo の支払い ID(pay_...)です。注文画面では、請求先住所の下に PayMongo チェックアウト、支払いインテント、モードが表示されます。

On hold:支払われた金額または通貨が注文と異なります(メモ amount/currency mismatch)。または、ストアが本番モードの間にテストモードで支払いが行われたため、お金は受け取られていません。または、在庫保持の期限切れなどで注文がキャンセルされた後に支払いが届きました。理由は注文メモに説明されています。注文を確認して処理するか、支払いを返金してください。

Failed:署名付きの payment.failed ウェブフックにより、保留中の注文の最新の支払い試行が失敗したことが報告されました。メモには PayMongo のエラーコードとメッセージが表示されます。購入者は再度支払うことができます。

すでに支払い済みの注文に対して、古いチェックアウトリンクなどから 2 回目の支払いが届いた場合、注文は変更されません。メモで、PayMongo ダッシュボードから重複分を返金するよう指示されます。支払い済みだったキャンセル済みまたは返金済みの注文が再び開かれることはありません。

返金

注文を開き、Refund をクリックして金額を入力し、Refund via PayMongo (Card, GCash, GrabPay, Maya) をクリックします(ボタンには支払い方法のタイトルが表示されます)。全額返金と一部返金に対応しています。返金は、支払いが行われたモード(テストまたは本番)のシークレットキーで送信されるため、そのキーが設定されている必要があります。PayMongo が返金を受け付けない場合、WooCommerce はエラーを表示し、返金は記録されません。返金に成功すると、PayMongo の返金 ID とステータスとともに注文メモに追加されます。

PayMongo ダッシュボードで行った返金は WooCommerce に反映されません。WooCommerce の注文から返金するか、WooCommerce で手動返金を作成してください。

ライセンスキー

このプラグインは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > PayMongo の上部にあります。キーを License key に貼り付けて、Activate をクリックします。ブロックには、ライセンスの有効期限などのステータスと、お使いのドメインが表示されます。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除できます。Manage licenses and domains in your account のリンクから、vibefox.net のアカウントを開けます。

1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、PayMongo はチェックアウトで購入者に表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、(unlicensed — visible to admins only) と表示された状態で支払い方法が表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインページと WooCommerce のページには、リマインダーが表示されます。既存の注文には影響しません。すでに開始された支払いは引き続き確認され、返金も利用できます。

ライセンスの有効期限が切れた後も、プラグインは動作を続けます。ただし、アップデートとサポートには更新が必要です。ステータスは、バックグラウンドで自動的に再確認されます。

トラブルシューティング

チェックアウトに PayMongo が表示されない:ライセンスが有効であること、Enable/Disable がオンであること、現在のモードにシークレットキー(テストモードでは Test secret key、本番モードでは Live secret key)があること、ストアの通貨が PHP であること、注文合計が ₱100.00 以上であることを確認してください。開発者は、paymongo_p_minimum_amount フィルターで最小金額を変更できます。

支払いは完了したが、注文が Pending payment のまま:ウェブフックが機能しておらず、購入者がストアに戻っていません。PayMongo ダッシュボードで、使用中のモードにウェブフックがあること、その URL が設定に表示されたものと正確に一致すること、3 つのイベントがすべて選択されていることを確認してください。署名シークレットが対応するフィールド(Test webhook secret または Live webhook secret)に入力されているか確認してください。

ウェブフックが Invalid signature と応答する:そのモードの署名シークレットが欠けているか、別のウェブフックのものです。ウェブフックの署名シークレットを、そのモードのフィールドに貼り付けてください。

ウェブフックが Mode mismatch と応答する:テストイベントが本番として署名されたか、その逆です。各ウェブフックが正しいモードに属していることを確認してください。

ウェブフックが Temporary error と応答する:PayMongo API で支払いを確認できなかったか、同じ瞬間に別のリクエストが注文を処理していました。PayMongo はウェブフックを自動的に再試行します。

値が保存されなかった:キーが誤ったフィールドに貼り付けられています。シークレットキーは sk_test_ または sk_live_ で、ウェブフックのシークレットは whsk_ で始まります。

注文時に購入者にエラーが表示される:注文メモを開くか、WooCommerce > Status > Logs(ソース wcp_paymongo_payment_gateway)を確認してください。誤ったシークレットキーの場合、支払い方法が一時的に利用できないという意味のメッセージが表示されます。PayMongo アカウントで有効になっていない支払い方法があると、PayMongo がチェックアウトを拒否します。その場合は Payment methods から削除してください。

本番ストアでのテスト支払い:ストアが本番モードの間に届いたテスト支払いは、お金が受け取られていないという旨のメモとともに、注文を保留にします。本番の支払いは、テストモードに戻った後でも常に認識され、本番用キーで返金されます。

支払い後に注文が On hold になる:注文メモを確認してください。支払われた金額または通貨が注文と異なった、支払いがテスト支払いだった、または注文がキャンセルされた後に届いた、のいずれかです。注文を処理するか、支払いを返金してください。

モードに関するメッセージで返金に失敗する:支払いはテストモードまたは本番モードで行われましたが、そのモードのシークレットキーが設定されていません。キーを入力して、もう一度お試しください。

ライセンスブロックにエラーが表示される:ブロックのメッセージに従ってください。たとえば、そのキーが別のドメインで使用されている場合は、vibefox.net のアカウントで枠を解放してから Check now をクリックしてください。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効にしてください。ライセンスサーバーに接続できない場合、プラグインは最後に確認されたステータスで動作を続けます。

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページで無効化してから削除してください。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定、一時データ、ログは、Delete data on uninstall がオンの場合にのみ削除されます。それ以外の場合は、後で再インストールするために残ります。既存の注文は、支払いメモ、取引 ID、PayMongo の ID を保持します。

PayMongo は、各所有者の商標です。本プラグインは PayMongo とは提携しておらず、PayMongo による推奨も受けていません。