戻る

VibeFox Satispay for WooCommerce — ヘルプ

動作要件

WordPress: 6.0 以降。

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

PHP: 8.0 以降。OpenSSL 拡張機能が必要です。OpenSSL がない場合、プラグインは管理画面でエラーを表示し、支払い方法は読み込まれません。

通貨: EUR。Satispay はユーロのみで決済を受け付けるため、ストアの通貨(注文の支払いページでは注文の通貨)が EUR でない場合、支払い方法は表示されません。

Satispay アカウント: Satispay Business アカウント。API キーをコピーする必要はありません。プラグインは、Satispay Business Dashboard で発行する 1 回限りの有効化コードで接続します(「設定」を参照)。テストには Satispay のサンドボックスアカウントが必要です。Satispay for developers から申請できます。

公開サイト: 決済の状態が変わったときに Satispay がサイトを呼び出せるよう、サイトがインターネットから到達可能である必要があります。このために Satispay 側で設定する必要はありません。

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

インストール

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

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

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

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

5. 環境を選択します。テスト時は Sandbox Mode にチェックを入れ、実際の決済ではチェックを外したままにします。

6. その環境の有効化コードを Activation Code に貼り付けて保存します。接続状態に Key ID が表示されます。

7. Enable/Disable をオンにして保存します。サンドボックスで決済をテストしたら、Sandbox Mode のチェックを外し、本番環境の有効化コードで本番環境を接続します。

設定

すべての設定は 1 つのページにあります: WooCommerce > Settings > Payments > Satispay。Satispay connection セクションには両方の環境の状態が表示されます。たとえば、Key ID 付きの Live: Connected や Sandbox: Not connected などで、使用中の環境も示されます。使用中の環境が接続されていない間、ページには 使用中の環境が接続されるまで、Satispay はチェックアウトに表示されません。 と表示されます。WooCommerce の支払い方法一覧では、使用中の環境が接続されるまで Satispay に設定が必要であることが示され、Sandbox Mode が有効な間はテストモードのバッジが表示されます。

Enable/Disable: Enable Satispay payment は支払い方法をオンまたはオフにします。デフォルト: オフ。

Checkout

購入者が支払い方法の一覧で目にする内容です。

Title: チェックアウトに表示される支払い方法の名前。デフォルト: Satispay。

Description: チェックアウトで支払い方法の下に表示されるテキスト。デフォルト: Pay with the Satispay app: scan the QR code or confirm the payment on your phone.

Satispay connection

Sandbox Mode: Use the Satispay sandbox (staging) environment。サンドボックスの決済には請求されません。デフォルト: オフ。サンドボックスと本番環境はキーが別々なので、それぞれの環境の有効化コードで接続してください。サンドボックスの使用中、購入者には支払い方法の下に サンドボックスモード: 実際の料金は請求されません。 と表示されます。

Activation Code: 上で選択した環境を接続するには、新しい 6 桁の有効化コードを貼り付けて保存します。本番環境のコードは Satispay Business Dashboard の Online shop セクションで発行されます。サンドボックスのコードは Satispay のサンドボックスアカウントに付属します。コードは 1 回だけ使用され、保存されません。現在の接続を維持する場合は、このフィールドを空のままにしてください。

コードを付けて保存すると、プラグインは RSA 鍵ペアを作成し、公開鍵とコードを Satispay に送信して、Key ID とその環境の鍵を WordPress データベースに保存します。成功すると、たとえば Satispay Live connected. Key ID: と ID がページに表示されます。Satispay がコードを拒否した場合、ページには Satispay からのメッセージが表示され、コードがこの環境のものであり、まだ使用されていないかを確認するよう求められます。英数字以外の文字を含むコードは、何も送信される前に拒否されます。ある環境に新しいコードを保存すると、以前の接続は置き換えられます。

Payment notifications

Satispay 側で設定することはありません。各決済には独自のコールバック URL があり、決済の状態が変わると Satispay がその URL を呼び出します。プラグインは注文を変更する前に、Satispay API から決済を再取得します。このセクションには、この URL の例が表示されます。形式は次のとおりです: https://your-site/wc-api/satispay_payment_callback/?action=callback&order_id={order}&payment_id={uuid}。この URL はインターネットから到達可能である必要があります。/wc-api/ にメンテナンスモードやパスワード保護があってはなりません。

Advanced

Debug log: Log API calls and payment events は、キーや購入者データを含めずに WooCommerce > Status > Logs に書き込みます(ソースは wcp_satispay_gateway)。この設定がオフでも、エラーは常に記録されます。デフォルト: オフ。

Delete data on uninstall: Remove the settings and Satispay keys when the plugin is deleted。注文に保存された決済データは保持されます。デフォルト: オフ。

チェックアウト

購入者は支払い方法(デフォルトは Satispay)を選び、Pay with Satispay をクリックします。プラグインは注文合計額(ユーロ建て)で Satispay の決済を作成し、注文番号を参照番号として付けたうえで、購入者を Satispay の決済ページに移動させます。パソコンでは、購入者は Satispay アプリで QR コードをスキャンします。スマートフォンでは、購入者はアプリで決済を確定します。

決済後、購入者はストアに戻ります。注文が支払い済みになるのは、Satispay が決済を確認した後だけです。プラグインは Satispay API から決済を取得し、その注文のために作成されたものかを確認したうえで、ステータス、金額(セント単位)、通貨を注文と照合します。これは、Satispay がコールバック URL を呼び出したときと、購入者が戻ったときの、どちらか早い方で行われます。決済がまだ確認されていない場合、注文受付ページには Satispay はまだお支払いを確認できていません。確認が届き次第、注文は自動的に更新されます。 と表示されます。

購入者が支払わずに Satispay のページを離れた場合、プラグインは Satispay で決済をキャンセルするため、放棄されたページでは支払いができなくなります。購入者はチェックアウト(または注文の支払いページ)に戻され、Your Satispay payment was cancelled and nothing was charged. You can try again or choose another payment method. というメッセージが表示されます。購入者がアプリで決済を拒否した場合も、同じメッセージが表示されます。

購入者は、未払いの注文を再度支払うことができます。たとえば Pay for order ページから支払えます。新しい Satispay 決済を作成する前に、以前の決済が確認されます。保留中の決済は Satispay でキャンセルされ、すでに支払い済みの場合は、その決済で注文が支払い済みになり、2 回目の決済は作成されません。

決済を開始できない場合、購入者には短いメッセージが表示され、別の支払い方法を選ぶことができます。ストアが接続されていない場合、または Satispay がキーを拒否した場合は Satispay is not available at the moment. Please choose another payment method.、その他のエラーの場合は Unable to create the Satispay payment. Please try again or choose another payment method. と表示されます。理由はログに記録されます。

この支払い方法は、従来のチェックアウト、チェックアウトブロック、Pay for order ページで利用できます。WooCommerce High-Performance Order Storage(HPOS)に対応しています。

プラグインが対応するのは、ユーロ建ての 1 回限りの決済のみです。サブスクリプション、保存済みの支払い方法、事前承認、食事券には対応していません。保留中の決済を定期的に確認する仕組みはありません。Satispay のコールバックも購入者の戻り操作もサイトに届かない場合、注文は「支払い待ち」のまま残り、決済は Satispay Dashboard で確認できます。

注文と返金

Order statuses

Pending payment: 購入者は Satispay に移動しましたが、まだ支払っていないか、Satispay がまだ決済を確認していません。注文メモには、Satispay の決済 ID、金額、環境(Live または Sandbox)が表示されます。

Processing or Completed: 決済が確認されました。注文は WooCommerce の標準ルールに従います。処理中(Processing)となるか、仮想のダウンロード商品だけの注文は完了(Completed)になります。注文メモには、Satispay の決済、金額、検証方法(コールバック、リダイレクト、チェックアウト)が表示されます。トランザクション ID は Satispay の決済 ID です。

On hold: Satispay が注文合計と異なる金額または通貨を報告したか、注文がキャンセルされた後に決済が受け付けられました。注文メモにその理由が記載され、決済は返金できるようにトランザクション ID として保存されます。Satispay Dashboard で決済を確認し、その後で注文を完了するか、決済を返金してください。

Cancelled: 注文の最新の Satispay 決済がキャンセルされたか、期限切れになりました。たとえば購入者が Satispay のページを離れた場合です。期限切れになった古い決済が、進行中の新しい決済がある注文をキャンセルすることはありません。管理画面で作成した注文(支払いリンク)はキャンセルされません。それらは注文メモ付きで「支払い待ち」のままになり、購入者は引き続き支払うことができます。

すでに支払い済みの注文に対して 2 回目の決済が受け付けられた場合、注文は変更されません。メモには、重複した決済を Satispay Dashboard から返金するよう案内が表示されます。繰り返しの確認によって、キャンセルされた注文や返金された注文が再び開かれることはありません。

Refunds

注文を開き、Refund をクリックし、金額を入力して Refund via Satispay をクリックします。Satispay で支払われた注文には、全額返金と一部返金の両方に対応しています。返金は決済が行われた環境(本番またはサンドボックス)に送信されるため、その環境が接続されたままである必要があります。返金は、Satispay が受け付けた場合にのみ完了とみなされます。成功した返金は、Satispay の返金 ID と理由とともに注文メモに追加されます。Satispay が返金を受け付けなかった場合、WooCommerce はエラーを表示し、返金は記録されません。

Satispay Dashboard で行った返金は、WooCommerce の返金には変換されません。必要に応じて、Refund via Satispay を使わずに WooCommerce で手動返金を作成してください。

ライセンスキー

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

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

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

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

トラブルシューティング

Satispay がチェックアウトに表示されない: ライセンスが有効であること、Enable/Disable がオンであること、使用中の環境が接続されていること(Satispay connection セクションにその環境の Connected が表示される)、通貨が EUR であることを確認してください。

決済は完了したのに注文が Pending payment のまま: Satispay がサイトを呼び出したとき、または購入者が戻ったときに注文は更新されます。サイトがインターネットから到達可能であること、/wc-api/ にメンテナンスモードやパスワード保護がないことを確認し、WooCommerce > Status > Logs(ソースは wcp_satispay_gateway)を確認してください。決済は Satispay Dashboard で確認できます。

コールバックが Payment status unavailable, retry later または Not configured を返す: プラグインが Satispay から決済を取得できなかったか、注文の環境が接続されていません。注文は変更されません。接続状態とログを確認してください。

コールバックが Busy, retry later を返す: 同じタイミングで別のリクエストが注文を更新していました。このコールバックでは注文は変更されません。次のコールバック、または購入者が戻ったときに更新されます。

コールバックが Unknown payment または Missing or invalid payment_id を返す: その決済はこの注文のために作成されていないか、リクエストが Satispay からのコールバックではありません。注文は変更されません。

有効化に失敗する: 有効化コードは 1 回しか使えません。Sandbox Mode で選択した環境のコードであることを確認してください(本番にはライブのコード、サンドボックスにはサンドボックスのコード)。新しいコードを発行し、再度保存してください。RSA 鍵ペアを生成できなかったと表示される場合は、ホスティング会社に PHP の OpenSSL 拡張機能を有効にするよう依頼してください。

サンドボックスから本番に切り替えた後、Satispay がチェックアウトから消えた: サンドボックスと本番では鍵が異なります。Sandbox Mode のチェックを外した状態で、本番の有効化コードを貼り付けて保存してください。

注文が On hold で、メモが注文と一致しない: Satispay が注文合計と異なる金額または通貨を報告しました。たとえば、決済の開始後に注文が編集された場合です。Satispay Dashboard で決済を確認し、その後で注文を完了するか、決済を返金してください。

環境が接続されていないため返金に失敗する: 決済は本番またはサンドボックスで行われましたが、その環境にはもう鍵がありません。有効化コードで再接続するか、Satispay Dashboard から決済を返金してください。

Satispay did not accept the refund と表示されて返金に失敗する: Satispay が accepted 以外のステータスを返しました。WooCommerce は返金を記録していません。Satispay Dashboard で確認してください。

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

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、Plugins ページで無効化してから削除してください。このプラグインのライセンスキーとライセンス状態は、常に削除されます。ゲートウェイの設定、両方の環境の Satispay キー、プラグインのログは、Delete data on uninstall がオンになっている場合にのみ削除されます。それ以外の場合は、後で再インストールする際に使えるように残ります。既存の注文は、決済メモとトランザクション ID を保持します。

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