戻る

VibeFox Peach Payments for WooCommerce — ヘルプ

要件

WordPress: 6.2 以降。

WooCommerce: 8.0 以降がインストール済みで有効なこと。これがないとプラグインを有効化できません。

PHP: 8.0 以降。

Currency: ストア通貨は ZAR、KES、MUR のいずれかである必要があります。他の通貨では決済方法は非表示となり、設定ページにその旨が表示されます。

Peach Payments account: Peach Payments アカウントの Card API 認証情報である Entity ID と Access Token が必要です。テスト用は Peach Payments サンドボックスダッシュボード、本番用は Peach Payments ダッシュボードから取得し、それぞれ異なります。ウェブフックには、貴店の Card ウェブフックを有効にした際に Peach Payments が送る復号キーも必要です(「設定」参照)。受信のため、サイトはインターネットからアクセスできる必要があります。

VibeFox license key: vibefox.net で購入します。キーは単一のドメインで使用できます。

インストール

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

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

3. WooCommerce > Settings > Payments > Peach Payments > Manage を開くか、プラグインページでプラグイン名の下にある Settings をクリックします。

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

5. Peach Payments サンドボックスダッシュボードのテスト用 Entity ID と Access Token を入力し、設定ページのウェブフック URL で Card ウェブフックを有効にするよう Peach Payments に依頼します(「設定」参照)。

6. Enable/Disable をオンにして保存します。Test mode はオンのまま、Peach Payments サンドボックスのテストカードで決済します。その後 Test mode のチェックを外し、本番認証情報と本番ウェブフックキーを入力して保存します。

バージョン 1.0 の設定は、更新後に新しいフィールドへ自動的に移行されます。

設定

設定はすべて WooCommerce > Settings > Payments > Peach Payments にあります。フィールドの上には、Test mode is on: payments go to the Peach Payments sandbox and no real money is charged.、現在のモードの Entity ID または Access Token がない場合の通知(入力するまでチェックアウトに決済方法が表示されません)、現在のモードのウェブフック復号キーがない場合の通知(購入者がストアに戻ったときのみ決済を確認)、ストア通貨が未対応の場合の通知が表示されます。決済方法一覧では、現在のモードに Entity ID と Access Token が設定されるまで Peach Payments は設定が必要と表示されます。保存時に認証情報から空白を除去し、ウェブフックキーが 64 文字の 16 進数でなければエラーを表示します。

Enable/Disable: Enable Peach Payments で決済方法をオンまたはオフにします。初期設定:オフ。

Title: チェックアウトで購入者に表示する決済方法名です。初期設定:Credit / Debit Card (Peach Payments)。

Description: チェックアウトで決済方法の下に表示する文章です。初期設定:Pay securely with your card. You will enter the card details in the Peach Payments form on the next page.

API 認証情報

Card API の Access Token と Entity ID は Peach Payments ダッシュボードに表示されます(テスト用はサンドボックスダッシュボード)。このセクションに両ダッシュボードと Peach Payments 開発者ドキュメントへのリンクがあります。

Test mode: Enable test mode はテスト認証情報を使って新規決済を Peach Payments サンドボックスへ送り、実際の請求は行いません。チェックを外すと、本番認証情報で実決済を受け付けます。開始した決済は、モード切り替え後も開始時のモードで必ず確認されます。初期設定:オン。

Test Entity ID: サンドボックスアカウントの Entity ID(3-D Secure チャネル)。

Test Access Token: サンドボックスアカウントの bearer アクセストークン。

Test Webhook Decryption Key: サンドボックスの Card ウェブフックを復号する 64 文字の 16 進数キー。

Live Entity ID: 本番アカウントの Entity ID(3-D Secure チャネル)。

Live Access Token: 本番アカウントの bearer アクセストークン。

Live Webhook Decryption Key: 本番アカウントの Card ウェブフックを復号する 64 文字の 16 進数キー。

ウェブフック

購入者が戻る前にブラウザーを閉じても、ウェブフックが決済を確認します。このセクションに https://your-site/wp-json/peach-pay/v1/webhook のような貴店のウェブフック URL が表示されます。設定の表示どおりに正確にコピーしてください。Peach Payments(support@peachpayments.com)にその URL でアカウントの Card ウェブフックを有効にするよう依頼し、届いた復号キーを同じモードの Webhook Decryption Key フィールドに入力します。

Peach Payments は各ウェブフックを暗号化します(AES-256-GCM)。テスト用または本番用キーで復号できないウェブフックは拒否されるため、注文を変更できるのは Peach Payments だけです。あるモードのキーで復号したウェブフックは、そのモードで開始した決済にのみ適用されます。次の決済通知を使用します:

Debit payment (DB): 注文のカード決済結果です。注文を支払い済み、保留中、または失敗に設定します(「注文」参照)。
Refund (RF), reversal (RV), chargeback (CB): Peach Payments ダッシュボードでの返金や取り消し、または報告されたチャージバックです。注文メモに追加され、注文ステータスは変わりません。

ウェブフック有効化時のテスト通知など、他の通知には OK と応答して無視します。ウェブフックキーがない場合、決済後に購入者が戻ったときのみ注文を確認します。

決済フォーム

Card brands: Peach Payments フォームに表示するブランド:Visa、Mastercard、American Express、Diners Club。Entity ID で有効なものだけを選んでください。初期設定:Visa と Mastercard。

詳細設定

Logging: Log API requests and payment results はデバッグ情報を WooCommerce > Status > Logs のソース wcp_peach_pay に記録します。エラーと警告は常に記録します。ログにカード情報、キー、購入者データは含まれません。初期設定:オフ。

Delete data on uninstall: Delete the plugin settings and logs when the plugin is deleted。無効化だけでは何も削除しません。注文に保存された Peach Payments データは保持します。初期設定:オフ。

チェックアウト

購入者は決済方法(初期設定は Credit / Debit Card (Peach Payments))を選び、Continue to payment をクリックします。貴店の Pay for order ページに移動すると、プラグインが注文総額と注文通貨で Peach Payments チェックアウトを作成し、選択したブランドのPeach Payments カードフォームを表示します。Peach Payments が対応している場合、サイトの言語で表示します。テストモードでは Test mode: use a Peach Payments test card, no real payment will be made. が表示されます。カード情報は Peach Payments フォームに入力し、フォームスクリプトは Subresource Integrity ハッシュ付きで読み込みます。

決済後、購入者はストアに戻ります。注文が支払い済みになるのは Peach Payments 確認後だけです。ストアは Peach Payments API からこの注文のチェックアウト結果を作成時のモードで取得し、決済がこの注文に属することを確認します。ウェブフックも独立して同じことを行い、先に届いた方が結果を適用し、もう一方は何も変更しません。支払った購入者には Order received ページが表示されます。

決済が完了しない場合、購入者はメッセージとともに Pay for order ページへ戻り、再試行できます。Payment failed: の後に Peach Payments の理由と Please try again or use another card.、または The payment was not completed. Please try again. が表示されます。結果をまだ確認できない場合(Peach Payments が応答しない、ウェブフックが同じ注文を処理中など)は We could not confirm your payment yet. If you were charged, the order will be updated automatically; otherwise please try again. を表示します。そのモードにウェブフックキーがない場合は、代わりに注文番号を添えて貴店へ連絡するよう案内します。

フォームを準備できない場合、購入者には短いメッセージと Try again ボタンを表示します。The payment form is not available right now (payment configuration error). Please contact us or choose another payment method.(認証情報が不正)、請求先情報の一部が決済事業者に受け付けられなかった旨、または The payment form could not be loaded. Please try again in a moment. です。注文には Peach Payments のコードと説明を含むメモを追加します。

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

チェックアウトページ自体のカードフォーム、保存済みカード、定期購入、事前承認とキャプチャ、EFT、BNPL、QR その他カード以外の決済方法には対応していません。

注文

注文ステータス

Pending payment: 購入者がまだ支払っていないか、決済が未完了です。同じ注文を再度支払えます。

Processing: 決済が確認され、金額と通貨が注文と一致しています。注文メモに Peach Payments の結果コード、説明、決済 ID が表示され、この ID が注文の取引 ID となります。Peach Payments が手動確認を求めた場合は、発送前に Peach Payments ダッシュボードで確認するようメモに記載します。

On hold: Peach Payments の確認待ち(ウェブフックが後で完了または失敗に設定)、支払い金額または通貨の不一致(メモ amount/currency mismatch — manual review required)、または注文キャンセル後に届いた決済です。確認すべき内容は注文メモに記載します。

Failed: 支払い待ち注文の決済、または保留中注文が待っていた決済を Peach Payments が拒否しました。拒否された試行によって、支払い済み、他の理由で保留中、キャンセル済みの注文は変わりません。購入者は再度支払えます。

支払い済み注文の二度目の決済が成功しても、注文は変更しません。重複決済である旨と Peach Payments ダッシュボードでの返金依頼をメモに記載します。返金済み注文への決済はメモに記録するだけです。

返金

WooCommerce 注文画面からの返金には対応していません。Peach Payments ダッシュボードで返金し、WooCommerce に手動返金を記録してください。ウェブフック設定済みの場合、Peach Payments の返金、取り消し、チャージバックを金額と ID 付きの注文メモとして追加します。注文ステータスは変わりません。

ライセンスキー

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

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

有効なキーがない場合、購入者のチェックアウトには Peach Payments が表示されません。それでも決済が開始された場合、This payment method is not available. Please choose another one. が表示されます。ログイン中のストア管理者には (unlicensed — visible to admins only) 付きで引き続き表示されるため、キー購入前に設定とテストができます。プラグインページと WooCommerce ページに通知が表示されます。既存注文には影響せず、開始済みの決済は購入者の帰還とウェブフックで引き続き確認されます。

ライセンス期限後もプラグインは動作しますが、更新とサポートには更新契約が必要です。ステータスはバックグラウンドで自動的に再確認します。

トラブルシューティング

チェックアウトに Peach Payments が表示されない:ライセンスが有効、Enable/Disable がオン、現在のモードの Entity ID と Access Token が入力済み(テスト時は Test Entity ID と Test Access Token、本番時は Live Entity ID と Live Access Token)、ストア通貨が ZAR、KES、MUR のいずれかであることを確認してください。設定上部の通知に問題が示されます。開発者は peach_p_supported_currencies フィルターで通貨一覧を変更できますが、Peach Payments アカウントが処理する通貨だけを追加してください。

決済成功後も注文が Pending payment のまま:購入者が戻らず、ウェブフックも届いていません。設定に表示された正確な URL で Peach Payments が Card ウェブフックを有効化したこと、決済時のモードの Webhook Decryption Key が入力済みであること、保守モード、ファイアウォール、パスワード保護が URL を遮断していないことを確認してください。WooCommerce > Status > Logs のソース wcp_peach_pay で拒否されたウェブフックを調べてください。

ウェブフックが Decryption failed を返す:テスト用または本番用キーで復号できませんでした。キーが不正か、他のアカウントやモードのものです。この URL 用に Peach Payments が送ったキーを入力してください。

ウェブフックが Webhook key not configured を返す:どちらのキーも未設定または無効です。64 文字のキーを入力してください。Peach Payments が後で再送します。

ウェブフックが Order busy, retry later を返す:購入者の帰還による注文更新が同時に行われていました。変更はなく、Peach Payments が再送します。

ウェブフックが Missing or malformed data を返す:暗号化本文または X-Initialization-Vector / X-Authentication-Tag ヘッダーがありません。プロキシによる変更などが考えられます。変更は行われませんでした。

ウェブフックが ignored を返す:通知は本物ですが、このストアのチェックアウトに属しません(同じ Entity ID の別ストア、削除済み注文)。または決済とは異なるモードから届きました。変更は行われませんでした。

購入者に The payment form is not available right now と表示される:現在のモードの Access Token または Entity ID が不正です。認証情報とモードを確認し、注文メモの Peach Payments コードを読んでください。

決済後の注文が On hold:注文メモを読んでください。金額や通貨が異なる、キャンセル後に決済が届いた、または Peach Payments がまだ確認待ちです。Peach Payments ダッシュボードで決済を確認後、注文を処理するか返金してください。

保存時に 64 文字の 16 進数ウェブフックキーが要求される:値が Peach Payments のキーではありません。修正するまでウェブフックを復号できません。

ライセンス欄にエラーが表示される:メッセージに従ってください。他のドメインで使用済みなら vibefox.net アカウントで枠を解放し Check now をクリックします。サイトアドレスが変わった場合は Check now で新ドメインに有効化します。ライセンスサーバーに接続できない場合、最後の既知のステータスで動作を続けます。

アンインストール

無効化ではすべてのデータを保持します。削除するには Plugins ページで無効化して削除してください。このプラグインのライセンスキーとステータスは常に削除します。設定とログ(ソース wcp_peach_pay のログファイルとデータベースログ項目)は Delete data on uninstall がオンの場合のみ削除し、それ以外は再インストール用に保持します。既存注文の決済メモ、取引 ID、Peach Payments チェックアウトデータは保持します。

Peach Payments はそれぞれの所有者の商標です。本プラグインは Peach Payments と提携しておらず、同社の承認も受けていません。