VibeFox ePayco for WooCommerce — ヘルプ
要件
WordPress: 5.8 以降。
WooCommerce: 7.0 以降。インストールされ有効になっている必要があります。WooCommerce がないとプラグインは有効化できません。
PHP: 8.0 以降。
ストアの通貨: コロンビアペソ(COP)または米ドル(USD)。その他の通貨では、チェックアウトに決済方法は表示されません。
ePayco アカウント: ePayco アカウントの 4 つのキーが必要です: P_CUST_ID_CLIENTE、P_KEY、PUBLIC_KEY、PRIVATE_KEY。これらは ePayco の管理画面の Integrations, API keys にあります。テストモードと本番モードで同じキーを使用します。購入者が利用できる決済方法(カード、PSE、現金払いのネットワーク、ウォレット)は、ePayco アカウントで有効になっているものです。
公開サイト: ストアの確認 URL はインターネットからアクセスできる必要があり、メンテナンスモード、ファイアウォール、ベーシック認証でブロックされていてはいけません。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に進み、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で wcp_epayco_payment フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます: WooCommerce > Settings > Payments > ePayco > Manage。または、プラグイン一覧画面のプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. ePayco の 4 つのキーを入力し、チェックアウトの種類を選択します(「設定」の項を参照)。
6. Enable/Disable をオンにします。ePayco のテストカードを使って Test Mode で決済をテストし、その後 Test Mode のチェックを外します。
設定
すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > ePayco。フィールドの上には、4 つのキーがすべて入力されていない場合(その場合、決済方法はチェックアウトで非表示になります)とストアの通貨が COP または USD でない場合に警告が表示され、テストモードが有効な間は Test mode is on: customers pay with ePayco test cards and no real money is charged. が表示されます。決済方法の一覧では、4 つのキーがすべて入力されるまで ePayco に設定が必要と表示されます。
一般
Enable/Disable: Enable ePayco Payment で決済方法を有効または無効にします。初期値: 無効。
Title: チェックアウトで購入者に表示される決済方法の名前。初期値: ePayco。
Description: チェックアウトで決済方法の下に表示される説明文。初期値: Pay securely with ePayco。
ePayco アカウントのキー
4 つのキーは ePayco の管理画面の Integrations, API keys にあります。P_CUST_ID_CLIENTE と P_KEY は支払いの確認通知を検証し、PUBLIC_KEY と PRIVATE_KEY はチェックアウトセッションを作成します。テストモードと本番モードで同じキーを使用します。
Customer ID (P_CUST_ID_CLIENTE): ePayco のお客様 ID(数字)。
Secret Key (P_KEY): ePayco の支払い確認通知の署名を検証するために使用します。秘密にしてください。
Public Key (PUBLIC_KEY): ePayco の公開 API キー。
Private Key (PRIVATE_KEY): ePayco の秘密 API キー。秘密にしてください。
Test Mode: Enable test mode を有効にすると、チェックアウトセッションはテスト取引として作成されます。購入者は ePayco のテストカードで支払い、実際の金額は請求されません。テスト取引が本番モードで作成された注文に対して支払いを行うことはありません。初期値: 無効。
チェックアウト
Checkout Type: ePayco のチェックアウトの開き方。
確認 URL
確認 URL は、支払いの結果をストアに伝えます。すべての支払いに対して自動的に ePayco に送信されるため、ePayco の管理画面で設定する必要はありません。この項目には URL が表示されます。例: https://your-site/wc-api/epc_p/。この URL はインターネットからアクセスできる必要があり、メンテナンスモード、ファイアウォール、ベーシック認証でブロックされていてはいけません。
各確認通知には、P_CUST_ID_CLIENTE と P_KEY を使って作成された有効な署名が必要です。有効な署名のない確認通知は拒否され、注文は変更されません。確認通知がない場合、購入者が支払い後にストアに戻ったときにのみ注文が更新されます。
詳細設定
Logging: Enable logging を有効にすると、API エラーと支払いの確認通知が WooCommerce > Status > Logs に、ソース wcp_epayco_payment として書き込まれます。キーと購入者データは記録されません。初期値: 無効。
Delete Data on Uninstall: Remove the gateway settings and logs when the plugin is deleted。プラグインを無効化しても何も削除されません。注文に保存された ePayco のデータは残ります。初期値: 無効。
チェックアウト
購入者は決済方法(初期値は ePayco)を選んで注文します。プラグインは、注文の通貨で注文合計に対する ePayco のチェックアウトセッションを作成し、注文の税金、注文番号、請求先の氏名、住所、メールアドレス、電話番号を含めます。チェックアウトの言語は、サイトの言語に合わせてスペイン語または英語になります。その後、購入者は注文の支払いページに進み、そこには Thank you for your order. The secure ePayco checkout opens automatically; if it does not, click the button below. と表示されます。ePayco のチェックアウトは、Checkout Type の設定に応じてポップアップまたはリダイレクトで開きます。このページには Pay with ePayco ボタンと Choose another payment method リンクもあります。テストモードでは、ページとチェックアウトに TEST MODE — use ePayco test cards, no real money is charged. と表示されます。
ePayco のチェックアウトでは、購入者は ePayco アカウントで有効になっている決済方法のいずれかで支払います。その後、ePayco が確認通知をストアに送信し、購入者をストアに戻します。注文が支払い済みになるのは、ePayco が確認した後だけです。署名付きの確認通知、または購入者が戻ったときにサーバーから ePayco に送られる照会によって確認されます。購入者が戻っただけでは、注文は支払い済みになりません。
支払いがまだ確認されていない場合、注文受付ページには We are waiting for ePayco to confirm your payment. This page does not need to stay open. と表示されます。保留中の支払い(PSE や現金払いなど)の場合は、Your ePayco payment is being confirmed. We will e-mail you as soon as it is approved. と表示されます。
支払いが拒否された場合、購入者は Pay for order ページに戻り、Your ePayco payment was declined or could not be completed. You can try again or choose another payment method. と表示されます。購入者が支払わずに戻った場合は、The ePayco payment was not completed. If you already paid, the order will be updated as soon as ePayco confirms it; otherwise you can try again. と表示されます。
ePayco が支払いを開始できない場合、購入者には短いメッセージが表示されます(例: We could not connect to ePayco. Please try again in a moment or choose another payment method.)。その理由は注文のメモとログに追加されます。
この決済方法は、クラシックチェックアウト、チェックアウトブロック、Pay for order ページで動作します。WooCommerce の高性能注文保存(HPOS)に対応しています。購入者に表示されるテキストはスペイン語に翻訳されています。
本プラグインは 1 回限りの支払いのみに対応しています。WooCommerce からの返金、保存済みカード、サブスクリプション、分割払いには対応しておらず、保留中の取引について ePayco への問い合わせも行いません。注文は ePayco の確認通知と購入者の戻りによって更新されます。
注文
注文ステータス
Pending payment: 購入者は ePayco に移動しましたが、まだ支払っていないか、ePayco がまだ支払いを確認していません。
Processing: 支払いが受理されました(仮想のダウンロード可能な商品のみの注文は、WooCommerce の既定どおり「完了」になります)。注文メモには ePayco の参照番号、状態、金額、決済方法、承認コードが表示されます。注文のトランザクション ID は ePayco の参照番号(ref_payco)です。
On hold, payment pending: ePayco が支払いを保留中または保留と報告しました(例: PSE 振込や現金払い)。ePayco が確認または拒否すると、注文は自動的に変わります。
On hold, amount/currency mismatch: ePayco が、注文と金額または通貨が異なる支払いを承認しました。ePayco の管理画面で取引を確認するまで、発送しないでください。
On hold, payment for a cancelled order: 注文がキャンセルされた後に、ePayco が支払いを承認しました。注文を復元するか、ePayco で支払いを返金してください。
Failed: 支払いが拒否、失敗、期限切れ、放棄、キャンセル、またはアンチフラウドによって停止されました。メモには ePayco の理由が表示されます。購入者は再度試すことができます。支払い完了後の遅延した失敗が支払い済みの注文を変更することはありません。
Refunded: ePayco がこの注文の支払いを返金しました。
支払い済みの注文に対して ePayco が別の承認済み支払いを報告した場合、ステータスは変わりません。メモで二重請求がないか確認し、必要に応じて ePayco で返金するよう促されます。本番モードで作成された注文に対するテスト取引や、すでに別の注文に属している取引は、メモ付きで無視されます。
返金: WooCommerce からの返金はサポートされていません。ePayco の管理画面で支払いを返金し、その後 WooCommerce で Refund manually を使って返金を記録してください。
ライセンスキー
本プラグインは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > ePayco の上部にあります。License key にキーを貼り付け、Activate をクリックします。ブロックには、ライセンスの有効期限日や使用中のドメインなどの状態が表示されます。Check now で状態を再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクから vibefox.net のアカウントを開けます。
1 つのキーは 1 つのドメインでのみ使用できます。サイトからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、ePayco はチェックアウトで購入者に表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。ログイン中のストア管理者には、(unlicensed — visible to admins only) と表示された決済方法が引き続き表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグインの画面と WooCommerce の画面にはリマインダーが表示されます。既存の注文には影響しません。すでに開始された支払いは引き続き確認されます。
ライセンスの有効期限が切れてもプラグインは動作を続けますが、アップデートとサポートには更新が必要です。ステータスはバックグラウンドで自動的に再確認されます。
トラブルシューティング
ePayco がチェックアウトに表示されない: ライセンスが有効か、Enable/Disable がオンか、4 つのキーがすべて入力されているか、ストアの通貨が COP または USD かを確認してください。Pay for order ページでは注文の通貨が確認されます。設定ページは、不足している項目があると警告を表示します。
支払いは完了したのに注文が Pending payment のまま: ePayco の確認通知がストアに届いていません。設定に表示されている確認 URL がインターネットから開けること、メンテナンスモード、ファイアウォール、セキュリティプラグイン、ベーシック認証でブロックされていないことを確認してください。Logging を有効にし、WooCommerce > Status > Logs でソース wcp_epayco_payment を確認してください。注文は、購入者が支払い後にストアに戻ったときにも更新されます。
確認通知が Invalid signature を返す: Customer ID (P_CUST_ID_CLIENTE) または Secret Key (P_KEY) が、支払いを受け付けた ePayco アカウントと一致しません。ePayco の管理画面から両方を再度コピーしてください。
確認通知が Gateway not configured を返す: P_CUST_ID_CLIENTE または P_KEY が空です。設定で入力してください。
確認通知が Busy, retry later を返す: 注文が同時に別のリクエストによって更新されていました。ePayco は確認通知を再試行します。
購入者に We could not connect to ePayco と表示される: ePayco が PUBLIC_KEY と PRIVATE_KEY を拒否しました。注文のメモに ePayco の応答が表示されます。両方のキーを再度コピーしてください。
購入者に ePayco could not start the payment と表示される: ePayco がチェックアウトセッションを作成できませんでした。注文のメモで ePayco のエラーを確認してください。
ePayco のチェックアウトが開かない: 購入者には The ePayco checkout could not be loaded. Please reload the page or choose another payment method. と表示されます。注文の支払いページで ePayco のチェックアウトスクリプトを読み込めませんでした。購入者はページを再読み込みするか、Choose another payment method を使用できます。
テスト支払いで注文が支払われなかった: テスト取引が本番モードで作成された注文に対して支払いを行うことはありません。Test Mode を有効にした状態でテスト注文を行ってください。
注文が On hold になっている: 注文のメモを確認してください。ePayco が支払いを保留中と報告したか、承認された金額または通貨が注文と異なったか、キャンセル後に支払いが届いた可能性があります。発送前に ePayco の管理画面で取引を確認してください。
ライセンスブロックにエラーが表示される: ブロックのメッセージに従ってください。例えば、キーが別のドメインで既に使われている場合は、vibefox.net のアカウントで枠を解放し、Check now をクリックします。サイトのアドレスが変わった場合は、Check now をクリックして新しいドメインでキーを有効化します。ライセンスサーバーに接続できない場合、プラグインは最後に確認された状態で動作を続けます。
開発者向けに、プラグインのドキュメントには次のフィルターが記載されています: epc_p_supported_currencies(決済方法を提供する通貨)、epc_p_session_payload(ePayco に送信されるデータ)、epc_p_icon(チェックアウトのアイコン)。
アンインストール
プラグインを無効化してもすべてのデータは保持されます。削除するには、無効化してから Plugins ページで削除してください。本プラグインのライセンスキーとライセンス状態は常に削除されます。ゲートウェイの設定とログは、Delete Data on Uninstall が有効だった場合にのみ削除されます。それ以外の場合は、後で再インストールするために残ります。注文に保存された ePayco のデータは常に保持されます。既存の注文は、支払いメモとトランザクション ID を保持します。
ePayco は、その所有者の商標です。本プラグインは ePayco と提携しておらず、ePayco の承認も受けていません。
