VibeFox Pin Payments for WooCommerce — ヘルプ
要件
WordPress: 6.2 以降。
WooCommerce: 7.1 以降。インストールされて有効になっている必要があります。WooCommerce がない場合、プラグインは有効化できません。
PHP: 8.0 以降。
HTTPS: カード決済の受け付けに必要なとおり(PCI DSS)、チェックアウトページでは HTTPS を使用する必要があります。カード情報は購入者のブラウザから Pin.js によって Pin Payments へ直接送信され、貴店のサーバーに届くことはないため、ストアは PCI SAQ A-EP の対象となります。
Pin Payments アカウント: Pin Payments の加盟店アカウント(オーストラリアまたはニュージーランドの企業向け。購入者はどこからでも支払うことができます)。本番用とテスト用の両方について、公開キー(publishable key)と秘密キー(secret key)が必要です。テスト用にはテスト環境のキーを使用します。ウェブフックのシークレットは不要です。本プラグインはウェブフックを使用しません。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選んで Install Now をクリックします。FTP で wcp_pinpayments_gateway フォルダを /wp-content/plugins/ にアップロードすることもできます。
2. Activate をクリックします。
3. 設定を開きます。WooCommerce > Settings > Payments > Pin Payments > Manage、またはプラグイン一覧のプラグイン名の下にある Settings をクリックします。
4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。
5. Pin Payments のダッシュボードで Account > API Keys を開き、テスト用キーを Test publishable key と Test secret key にコピーします。Test mode はオンのままにし、Enable/Disable をオンにして保存します。
6. Pin Payments のテストカードでテスト注文を行います。すべて正常に動作したら、本番用キーを入力し、Test mode をオフにして保存します。
設定
すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > Pin Payments。フィールドの上には、テストモードがオンの間は通知、現在のモードの公開キーまたは秘密キーが空の間はエラー、そして Pin Payments がストアの通貨に対応していない場合はエラー(対応通貨の一覧付き)が表示されます。後の 2 つの場合、チェックアウトでは支払い方法が非表示になります。保存後は、通知にすぐ新しいモードとキーが反映されます。支払い方法の一覧では、現在のモードに両方のキーが入力されるまで、この支払い方法に設定が必要であることが表示されます。
Enable/Disable: Enable Pin Payments で支払い方法のオン/オフを切り替えます。既定値: オフ。
Title: チェックアウトで表示される支払い方法のタイトル。既定値: Credit card (Pin Payments)。
Description: チェックアウトで表示される支払い方法の説明。既定値: Pay with your credit card via Pin Payments。
API キー
キーは Pin Payments のダッシュボードの Account > API Keys にあります。テスト用キーはテスト API でのみ、本番用キーは本番 API でのみ使用できます。公開キーは購入者のブラウザ内で Pin.js が使用します。秘密キーが貴店のサーバーの外に出ることはありません。
Test mode: Enable test mode。Pin Payments のテスト環境(test-api.pinpayments.com)とテスト用キーを使用します。実際の請求は行われず、購入者にはカードフォームで テストモード — 実際の請求は行われません。 と表示されます。オフの場合は、本番 API(api.pinpayments.com)と本番用キーが使用されます。既定値: オン。
Test publishable key: Pin Payments のテストアカウントの公開キー。
Test secret key: Pin Payments のテストアカウントの秘密キー。パスワードフィールドです。
Live publishable key: Pin Payments の本番アカウントの公開キー。
Live secret key: Pin Payments の本番アカウントの秘密キー。パスワードフィールドです。
キーの前後の空白は削除されます。現在のモードの両方のキーに値が入力されている必要があります。そうでなければ、チェックアウトに支払い方法は表示されません。
詳細設定
Debug log: Log Pin Payments API calls — ログは WooCommerce > Status > Logs に、ソース wcp_pinpayments_gateway として保存されます。エラーは常に記録されます。すべての API 呼び出しも記録するには、この設定をオンにします。カード情報、API キー、購入者の個人データがログに記録されることはありません。既定値: オフ。
Delete data on uninstall: Delete the gateway settings and logs when the plugin is deleted。プラグインを無効化しても、何も削除されることはありません。注文に保存された支払いデータは常に保持されます。既定値: オフ。
チェックアウト
購入者は支払い方法を選択し(既定では Credit card (Pin Payments)、Visa、Mastercard、American Express のアイコン付き)、チェックアウトで Card number、Expiry (MM / YY)、CVC、Name on card を入力します。送信前に、カードフォームはカード番号の桁数、有効期限の月と年、3 桁または 4 桁の CVC、および名義を確認します。
注文が確定すると、Pin.js がブラウザから Pin Payments へカード情報と請求先住所を直接送信し、1 回限りのカードトークンを取得します。貴店のサーバーに送信されるのはこのトークンだけです。その後、サーバーは注文通貨で注文合計額の、説明 <store name> - Order <number> 付きのキャプチャ済み請求を作成します。Pin Payments は同じリクエスト内で応答します。Pin Payments が請求の成功を報告し、注文の金額と通貨にぴったり一致した場合にのみ、注文は支払い済みになります。その後、購入者は注文受付ページに移動します。
注文ごとに、一度に実行される支払い試行は 1 回だけです。2 回目の送信には この注文は現在支払い処理中です。しばらく待ってから、再試行する前にメールを確認してください。 と表示されます。すでに支払い済みの注文、または請求済みで保留中の注文は、再度請求されることはありません。カードトークンは 1 回だけ使用できます。支払いに失敗した後や、購入者がカード情報を変更した場合には、新しいトークンが作成されます。
購入者に表示される可能性のあるメッセージ: カードが拒否されました。別のカードを使用するか、カード発行会社にお問い合わせください。; カードの残高が不足しています。別のカードを使用してください。; カードの有効期限が切れています。別のカードを使用してください。; カードのセキュリティコード(CVC)が正しくありません。; このカードの種類はご利用いただけません。Visa、Mastercard、American Express をご利用ください。; 支払いに失敗しました: 拒否された情報について Pin Payments が示した理由付き; カード情報の有効期限が切れています。再度入力してからもう一度お試しください。(トークンを使用できない場合); 安全なカードフォームを読み込めませんでした。ページを再読み込みするか、別の支払い方法を選択してください。(Pin.js が読み込まれない場合); 現在カード支払いをご利用いただけません。しばらくしてから再度お試しいただくか、別の支払い方法を選択してください。(Pin Payments が秘密キーを拒否した場合); Pin Payments での支払いを確認できませんでした。再試行の前にメールとカードの利用明細を確認するか、お問い合わせください。(Pin Payments が応答しない場合)。技術的な詳細は注文メモとログに記録されます。
この支払い方法は、クラシックチェックアウト、チェックアウトブロック(同じカードフィールドを使用)、Pay for order ページで動作します。WooCommerce の High-Performance Order Storage(HPOS)に対応しています。
このプラグインには 3-D Secure の処理フローはありません。Pin Payments アカウントで 3-D Secure が必須になっている場合、請求は保留のままになり、プラグインは注文を失敗させます。そのため、この試行では料金は請求されません。購入者には カード支払いを完了できませんでした(追加の確認が必要です)。別のカードまたは別の支払い方法をお試しください。 と表示されます。後で売上計上する承認のみのモード、保存済みカード、WooCommerce Subscriptions、Apple Pay または Google Pay、ウェブフックは利用できません。
注文と返金
Order statuses
Processing: Pin Payments が、注文の金額と通貨にぴったり一致する、成功してキャプチャ済みの請求を報告しました。仮想のダウンロード可能商品のみの注文は、WooCommerce の既定値どおり完了に変わります。注文メモには金額と請求トークンが表示されます(テスト支払いの場合は TEST MODE も表示されます)。トランザクション ID は Pin Payments の請求トークンです。
Failed: カードが拒否されたか、請求が保留のまま残った(3-D Secure)、または Pin Payments が秘密キーまたはリクエストを拒否しました。失敗するたびに、Pin Payments のエラーコードとメッセージを含む注文メモが追加されます。以前の試行ですでに注文が失敗していた場合も同様です。購入者は同じ注文で再試行できます。
Pending payment: Pin Payments から明確な回答がありませんでした(タイムアウト、サーバーエラー、読み取れない応答)。請求が作成されている可能性があるため、注文は失敗扱いになりません。メモには、購入者が再度支払う前や注文を発送する前に、Pin Payments のダッシュボードで請求の説明を確認するよう記載されています。この状態は支払い待ちです。
On hold: Pin Payments が注文と異なる金額または通貨を請求しました(メモには想定金額と請求金額が表示されます)。または、請求は承認されましたがキャプチャされていません。注文を処理する前に、Pin Payments のダッシュボードで請求を確認してください。
返金
注文を開き、Refund をクリックして金額を入力し、Refund via Credit card (Pin Payments) をクリックします(ボタンには Title の値が表示されます)。全額返金と一部返金に対応しています。返金は注文が支払われた環境(テストまたは本番)に送信されるため、そのモードの秘密キーが設定されている必要があります。リクエストが成功すると、金額、Pin Payments の返金トークン、およびそのステータスを含む注文メモが追加されます。Pin Payments は返金を非同期で処理するため、ステータスは通常 Pending になります。Pin Payments が返金を拒否した場合、または応答がない場合、WooCommerce はエラーを表示し、返金は記録されません。
Pin Payments のダッシュボードで行った返金は WooCommerce に同期されません。そのため、返金は WooCommerce から行ってください。
ライセンスキー
このプラグインは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Payments > Pin Payments の上部にあります。キーを License key に貼り付けて、Activate をクリックします。ブロックには、ライセンスの有効期限日やお使いのドメインなどのステータスが表示されます。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクを開くと、vibefox.net のアカウントが表示されます。
1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、Pin Payments はチェックアウトで購入者に表示されません。それでも支払いが開始された場合、購入者には この支払い方法はご利用いただけません。別の方法をお選びください。 と表示されます。ログイン中のストア管理者には、(ライセンスなし — 管理者にのみ表示) と表示された状態で支払い方法が表示されるため、キーを購入する前にプラグインを設定してテストできます。プラグイン一覧ページと WooCommerce のページに注意事項が表示されます。既存の注文には影響しません。返金も引き続き利用できます。
ライセンスの期限が切れた場合も、プラグインは動作を続けますが、アップデートとサポートには更新が必要です。ステータスはバックグラウンドで自動的に再確認されます。
トラブルシューティング
チェックアウトに Pin Payments が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、現在のモードの両方のキーが入力されていること(テストモードでは Test publishable key と Test secret key、それ以外の場合は本番用キー)、およびカートの通貨が対応する 14 通貨のいずれかであることを確認してください。Pay for order ページでは注文の通貨が対象になります。設定ページには、キーが不足している場合と、通貨が非対応の場合のエラーが表示されます。
チェックアウトに「Pin Payments での支払いを確認できませんでした」と表示される: Pin Payments が時間内に応答しませんでした。注文は、メモ付きで支払い待ちのままになります。購入者が再度支払う前や注文を発送する前に、Pin Payments のダッシュボードで説明が <store name> - Order <number> の請求を探してください。プラグインはそのような請求を自動的には検索せず、新しい試行を行うと新しい請求が作成されます。
購入者に「現在カード支払いをご利用いただけません」と表示される: Pin Payments が秘密キーを拒否しました。注文メモには、現在のモードのキーを確認するよう記載されています。テスト用キーはテストモードでのみ、本番用キーは本番モードでのみ動作します。
注文が「追加の確認が必要です」で失敗する: Pin Payments アカウントで 3-D Secure が必須になっていますが、このプラグインは 3-D Secure に対応していません。Pin Payments に、必須の 3-D Secure を無効にするよう依頼してください。
注文が On hold になり、「does not match」というメモが付いている: Pin Payments が、注文と異なる請求金額または通貨を報告しました。Pin Payments のダッシュボードで請求を確認し、手動で返金するか注文を完了させてください。
安全なカードフォームを読み込めませんでした: Pin Payments の CDN からの Pin.js がブラウザで読み込まれませんでした。例えば、スクリプトブロッカーや、スクリプトを変更するキャッシュ系またはパフォーマンス最適化系のプラグインが原因の場合があります。チェックアウトをそのような最適化の対象から除外してください。
返金が失敗する: メッセージを確認してください。TEST または LIVE モードに関するメッセージは、注文の支払い時のモードの秘密キーが空であることを意味します。Pin Payments が返金を確認できませんでした は、応答が届かなかったことを意味します。再試行する前に、Pin Payments のダッシュボードで請求を確認してください。
Pin Payments の理由で支払いが失敗する: Pin Payments が請求の詳細を拒否しました。例えば、その通貨の最低請求額を下回る金額の場合です。購入者には理由が表示され、注文メモにはエラーコードが記録されます。
テスト支払い: テストモードはテスト環境とテスト用キーを使用します。Pin Payments の開発者向けドキュメントにあるテストカードを使用してください。例えば、4200 0000 0000 0000(成功)または 4100 0000 0000 0001(拒否)です。有効期限は将来の任意の日付、CVC は任意で構いません。注文は支払い時のモードを保持するため、モードを切り替えた後も、返金は正しい環境に送信されます。
エラーの確認場所: エラーは常に WooCommerce > Status > Logs に、ソース wcp_pinpayments_gateway として書き込まれます。すべての API 呼び出しを確認するには、Debug log をオンにしてください。
ライセンスブロックにエラーが表示される: ブロックに表示されたメッセージに従ってください。例えば、そのキーが別のドメインで使用されている場合は、vibefox.net のアカウントで枠を解放してから Check now をクリックします。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効にします。ライセンスサーバーに接続できない場合、プラグインは最後に確認できたステータスで動作を続けます。
開発者向け: フィルター wc_ppg_supported_currencies は通貨の一覧を変更し、wc_ppg_icon は WooCommerce の支払い方法一覧にあるアイコンを変更します。
アンインストール
プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページでプラグインを無効化して削除してください。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。ゲートウェイの設定、プラグインのバージョンオプション、およびそのログ(ローテーションされたログファイルを含むログファイルと、データベースのログエントリ)は、Delete data on uninstall がオンの場合にのみ削除されます。それ以外の場合は、後で再インストールするために残されます。Pin Payments の請求トークンなど、注文に保存された支払いデータは決して削除されません。既存の注文は、支払い備考とトランザクション ID を保持します。
Pin Payments は、その所有者の商標です。本プラグインは Pin Payments と提携しておらず、Pin Payments による推奨も受けていません。
