戻る

VibeFox Paystack for WooCommerce — ヘルプ

要件

WordPress:5.8 以降。

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

PHP:8.0 以降。

通貨:注文は Paystack が受け付ける通貨である必要があります:NGN、USD、GHS、ZAR、KES、XOF、EGP、RWF のいずれか(Paystack アカウントで有効になっているもの)。それ以外の通貨では、決済方法は非表示になります。XOF と RWF では、Paystack は整数の金額のみを受け付けます。

Paystack アカウント:Paystack アカウントのシークレットキーが必要です。テスト用シークレットキー(sk_test_...)および/または本番用シークレットキー(sk_live_...)です。支払いは Paystack のホスト型ページで行われるため、公開キー(pk_...)は不要です。Paystack ダッシュボードでストアの Webhook URL も設定します(設定を参照)。Webhook を受信するには、サイトがインターネットから到達可能である必要があります。

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

インストール

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

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

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

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

5. Paystack ダッシュボードからシークレットキーを貼り付け、Paystack ダッシュボードで Webhook URL を設定します(設定を参照)。

6. Enable/Disable をオンにして保存します。テスト支払いを行うまで Test Mode はオンのままにし、その後オフにすると実際の支払いを受け付けます。

設定

すべての設定は1つのページにあります:WooCommerce > Settings > Payments > Paystack。フィールドの上にあるステータスボックスには、現在のモードが表示されます:テストモード:実際の料金は請求されません。 または 本番モード:実際の支払いを受け付けます。 また、現在のモードのシークレットキーが空の場合、公開キー(pk_...)がシークレットキーのフィールドに入力されている場合、本番モードにテストキー(sk_test_...)がある場合、またはテストモードに本番キー(sk_live_...)がある場合、さらに Paystack がストアの通貨を受け付けない場合にも警告が表示されます。キーに問題がある間は、チェックアウトで決済方法が非表示になります。決済方法の一覧では、現在のモードにシークレットキーが設定されるまで、Paystack は設定が必要とマークされます。

チェックアウト

Enable/Disable:Enable Paystack Payment で決済方法のオン/オフを切り替えます。デフォルト:オフ。

Title:お客様がチェックアウトで見る決済方法の名前。デフォルト:Paystack。

Description:チェックアウトで決済方法の下に表示されるテキスト。デフォルト:Pay securely using your debit card, credit card, or bank account via Paystack。

API キー

Paystack ダッシュボードの Settings > API Keys & Webhooks ページからシークレットキーをコピーします。このセクションにはそのページへのリンクがあります。

Test Mode:Enable Test Mode は、新しい支払いにテスト用シークレットキーを使用します。実際の料金は請求されません。オフにすると、本番用シークレットキーで実際の支払いを受け付けます。別のモードで行われた支払いは、検証と返金のために、そのモードのキーを引き続き使用します。デフォルト:オン。

Test Secret Key:Paystack のテスト用シークレットキーです。sk_test_ で始まります。

Live Secret Key:Paystack の本番用シークレットキーです。sk_live_ で始まります。

Webhook

Webhook は、お客様がストアに戻らなくても、支払いが行われたことをストアに通知します。Paystack ダッシュボードの Settings > API Keys & Webhooks ページで、このセクションに表示されている URL を、Test Webhook URL と Live Webhook URL の両方に設定してください。形式は https://your-site/wc-api/paystack_p_webhook/ のようになります。URL は設定に表示されているとおりに正確にコピーしてください。

Paystack はすべての Webhook をお使いのシークレットキーで署名するため、ほかに設定するものはありません。テスト用 Webhook はテスト用シークレットキーで、本番用 Webhook は本番用シークレットキーで検証されます。有効な署名のない Webhook は拒否されます。プラグインは charge.success イベントを使用します:

charge.success:支払いが行われました。プラグインは Paystack API からトランザクションを読み取り、すべてが一致すれば注文を支払い済みにします。

その他のイベントには OK で応答し、無視されます。Webhook がない場合、注文は、お客様が支払い後にストアに戻ったときにのみ確認されます。後で完了する銀行振込や USSD の支払いは、Webhook によってのみ確認されます。

注文

Autocomplete Order:Automatically mark orders as completed after successful payment。オンにすると、支払い済みの注文は、Processing ではなく完了になり、ステータス変更は1回、お客様へのメールは1通になります。デフォルト:オフ。

詳細設定

Debug log:Log Paystack events and API calls for debugging を有効にすると、詳細が WooCommerce > Status > Logs に書き込まれます。ソースは wcp_paystack_payment です。エラーは常に記録されます。キーとお客様のデータは決してログに記録されません。デフォルト:オフ。

Delete data on uninstall:Remove the gateway settings and logs when the plugin is deleted。プラグインを無効化しても何も削除されません。注文に保存された支払いデータは常に保持されます。デフォルト:オフ。

チェックアウト

お客様は決済方法(デフォルトは Paystack)を選択し、注文を確定します。テストモードの場合、チェックアウトには TEST MODE ENABLED. No real charges will be made. と表示されます。プラグインは、注文通貨での注文合計額について、注文の請求先メールアドレスとともに Paystack トランザクションを開始し、お客様を Paystack のホスト型チェックアウトページに移動させます。そこでお客様は、Paystack アカウントで有効になっているチャネルのいずれかで支払います。

支払い後、お客様はストアに戻ります。注文は、Paystack が確認した後にのみ支払い済みになります。お客様が戻ったときと Webhook が届いたときの両方で、プラグインは支払いを開始したモードのシークレットキーを使って Paystack API からトランザクションを読み取り、参照、ステータス、金額、通貨を確認します。銀行振込など、支払いがまだ処理中の場合、注文受付ページには Your payment is being confirmed by Paystack. You will receive an email as soon as it is confirmed.(お支払いは Paystack で確認中です。確認が取れ次第、メールでお知らせします。)と表示されます。注文は、後から届いた Webhook によって完了します。

お客様が Paystack のページでキャンセルしたり、支払わずにページを離れたりした場合、注文は支払いを待ち続けます。お客様は、Payment was cancelled. You can try again or choose another payment method.、The payment was not completed. You can try again or choose another payment method.、Your payment was declined. You can try again or choose another payment method. などのメッセージとともに、チェックアウトまたは Pay for order ページに戻ります。お客様は同じ注文を再度支払うことができます。注文の以前の支払いページも引き続き有効で、後からそのページで支払いが行われた場合でも、支払いは受け付けられます。

注文受付ページは、その注文のお客様のみに開きます。署名付きの戻りリンク、注文を作成したチェックアウトセッション、またはお客様のアカウントが対象です。それ以外の人はチェックアウトに移動し、中立的なメッセージが表示されます。注文ページは表示されません。

Paystack が支払いを開始できない場合、お客様には Paystack could not start the payment: に続けて Paystack からの理由が表示されるか、Paystack is temporarily unavailable. Please try again in a moment or choose another payment method. のような短いメッセージが表示されます。注文合計は0より大きい必要があり、注文には有効なメールアドレスが必要です。

この決済方法は、従来のチェックアウト、チェックアウトブロック、および Pay for order ページで動作します。WooCommerce の High-Performance Order Storage(HPOS)に対応しています。

このプラグインには、埋め込み型またはポップアップの決済フォーム、保存済みカード、サブスクリプション、分割払い、サブアカウントはなく、WooCommerce 内での決済チャネルの選択もできません。

注文と返金

注文ステータス

Pending payment:お客様は Paystack に移動しましたが、まだ支払っていないか、支払わずに Paystack のページを離れたか、または支払いが Paystack でまだ処理中です。お客様が支払わずに戻った場合、注文はまだ支払いを待っていることがメモに示されます。

Processing or Completed:支払いが確認されました。Autocomplete Order がオンの場合、ステータスは完了になります。注文メモには、金額、Paystack 参照番号、トランザクション番号、モード(テストまたは本番)、支払いチャネル、カード支払いの場合はカードの種類と下4桁、そしてお客様が支払った Paystack の手数料が表示されます。注文のトランザクション ID は Paystack 参照番号(order_...)です。

On hold:支払われた金額または通貨が注文と異なる(メモ Paystack amount or currency mismatch)、または注文がキャンセルされた後に支払いが届いた場合です。注文メモには、確認すべき内容が記載されています。注文を処理するか、支払いを返金してください。

Failed:Paystack が、保留中の注文の最新の支払い試行が失敗したか取り消されたと報告しています。以前の試行の失敗は、注文に影響しません。お客様は再度支払うことができます。

すでに支払い済みの注文に対する2回目の支払い試行も成功した場合、注文は変更されません。メモで、Paystack ダッシュボードから重複した支払いを返金するよう促されます。Refunded など別のステータスの注文に届いた支払いは、注文にメモされるだけです。

返金

注文を開き、Refund をクリックして金額を入力し、Refund via Paystack をクリックします。全額返金と一部返金に対応しています。返金ボタンは、検証済みの Paystack トランザクションを通じて支払われた注文にのみ表示されます。返金は、注文を支払ったトランザクションに対して、そのトランザクションが行われたモード(テストまたは本番)のシークレットキーを使って行われるため、そのモードのキーが設定されている必要があります。XOF と RWF では、返金は整数の金額である必要があります。Paystack は返金をキューに入れます。注文メモには、Paystack が返した状態(例:pending)と返金 ID が表示されます。Paystack が返金を受け付けない場合、WooCommerce は理由とともに Paystack refund failed: を表示し、返金は記録されません。

Paystack ダッシュボードで行われた返金、および Paystack がキューに入れた返金の最終ステータスは、WooCommerce には同期されません。必要に応じて手動で記録してください。

ライセンスキー

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

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

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

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

トラブルシューティング

チェックアウトに Paystack が表示されない:ライセンスが有効であること、Enable/Disable がオンであること、現在のモードに正しいシークレットキーがあること(テストモードでは sk_test_... の Test Secret Key、本番モードでは sk_live_... の Live Secret Key)、そして注文の通貨が Paystack で受け付けられるものであることを確認してください。設定の上部にあるステータスボックスに問題が表示されます。

支払いは完了したのに、注文が Pending payment のまま:Webhook がストアに届かず、お客様も戻っていません。Paystack ダッシュボードで、Test Webhook URL と Live Webhook URL が設定に表示されている URL と完全に一致しているか、メンテナンスモード、ファイアウォール、パスワード保護によってブロックされていないかを確認してください。拒否された Webhook については、WooCommerce > Status > Logs をソース wcp_paystack_payment で確認してください。

Webhook が Invalid signature を返す:Webhook が、設定に入力されたテストまたは本番のシークレットキーで署名されていません。たとえば、キーが別の Paystack アカウントのものである場合などです。Webhook を送信しているアカウントのキーを入力してください。

Webhook が Secret key not configured を返す:どちらのシークレットキーも設定されていません。設定でシークレットキーを入力してください。

Webhook が Verification failed または Busy, retry later を返す:その時点で Paystack API からトランザクションを読み取れなかったか、お客様が戻ったことで注文が同時に更新されていました。注文は変更されず、Paystack は Webhook を再送します。

Webhook が OK - unknown reference を返す:その支払いは、このストアの注文に対するものではありません。たとえば、Paystack の支払いページや、同じアカウント上の別の連携などです。無視されます。

お客様に Payment gateway is not properly configured と表示される:現在のモードのシークレットキーがないか、誤っています。設定の上部のステータスボックスの指示に従って修正してください。

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

モードに関するメッセージが表示され、返金が失敗する:支払いはテストまたは本番モードで行われ、そのモードのシークレットキーが設定されていません。キーを入力してから、もう一度お試しください。No verified Paystack payment was found for this order というメッセージは、注文が検証済みの Paystack トランザクションを通じて支払われていないことを意味します。Paystack ダッシュボードで返金してください。

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

アンインストール

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

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