VibeFox iPay88 for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 から 9.x。

PHP: 8.0 以降。モジュールは古い PHP バージョンではインストールされません。

iPay88 加盟店アカウント: Merchant Code と Merchant Key は、加盟店アカウントが有効化された時点で iPay88 から発行されます。iPay88 加盟店ポータルにも表示されます。まだ加盟店でない場合は、iPay88 の Web サイトから申し込んでください。Merchant Key は秘密に保管してください。支払いに署名するためのキーです。iPay88 には独立したサンドボックスがないため、テスト用のキーはありません。

リクエスト URL: サイトのアドレスを iPay88 にリクエスト URL として登録する必要があります。登録しないと、iPay88 のページに "Permission not allow" と表示されます。

通貨: Malaysia — MYR、iPay88 アカウントで複数通貨オプションが有効な場合は USD、SGD、AUD、CAD、EUR、GBP、HKD、CNY、TWD、INR、IDR、PHP、THB。Philippines — PHP または USD。Indonesia — IDR。Thailand — THB。カートの通貨をお客様の地域で請求できない場合、チェックアウトで支払い方法が非表示になります。

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

インストール

1. 管理画面で Modules > Module Manager に進み、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。

2. アップロードが完了したら Configure をクリックします。後でモジュール一覧から VibeFox iPay88 Payment を探し、Configure をクリックすることもできます。

3. Configure ページ上部のライセンスブロックで、License key に VibeFox ライセンスキーを入力し、Activate をクリックします（ライセンスキーを参照）。

4. iPay88 region を選択し、Merchant Code と Merchant Key を入力し、Enable/Disable をオンにして、Save をクリックします。

5. 設定を確認するには、Test mode をオンにした状態で支払いを行い、その後テストモードをオフにします。

インストール時にモジュールは 2 つの注文ステータスを作成します：Awaiting iPay88 payment と iPay88 payment on hold。PrestaShop は、すべての通貨、国、顧客グループで新しい支払いモジュールを有効にします。Payment > Preferences で制限できます。モジュールのインストール後に有効にした国も、そこでこのモジュールにチェックを入れる必要があります。そうしないと、その国のお客様には iPay88 が表示されません。レスポンス URL と backend URL は、支払いごとに送信されます。

設定

すべての設定はモジュールのページにあります：Modules > Module Manager > VibeFox iPay88 Payment > Configure。各 Save ボタンはページ全体を保存します。フィールドの上には、キーが未入力の間は iPay88 の Merchant Code と Merchant Key を入力してください。それまではチェックアウトで支払い方法が表示されません。 と表示されます。また、ストアの既定の通貨を選択した地域で請求できない場合は警告が表示され（その場合、チェックアウトで支払い方法が非表示になります）、テストモードがオンの間は警告が表示されます。

iPay88

Enable/Disable: Enable iPay88 Payment Gateway は、支払い方法のオン／オフを切り替えます。既定値：オフ。

Title: チェックアウトでお客様に表示される支払い方法の名称です。注文に保存される支払い方法の名称にもなります。既定値：iPay88。

Description: チェックアウトで支払い方法の下に表示されるテキストです。既定値：Pay securely via iPay88 (credit card, online banking, e-wallet)。

iPay88 アカウント

iPay88 region: iPay88 加盟店アカウントの国です。iPay88 の決済ページと請求可能な通貨を決定します。注文は常にその通貨で請求されます。既定値：Malaysia。

Merchant Code: iPay88 の Merchant Code です。例：M01234。

Merchant Key: iPay88 の Merchant Key です。支払いリクエストに署名し、iPay88 からの応答を検証します。秘密に保管してください。保存済みのキーは再表示されません。フィールドは空のままで、保存済み — 変更しない場合は空のままにしてください。 と表示されます。値を変更する場合にのみ新しい値を入力します。キーは引用符やバックスラッシュを含め、入力したとおりに保存されます。

Clear saved secret: Merchant Key にチェックを入れて Save をクリックすると、保存済みのキーが削除されます。フィールドが空の場合は、保存済みの値が維持されます。

Signature type: 支払いリクエストの署名方式です。応答は両方の形式で検証されるため、切り替える前に開始された支払いも検証可能なままです。

支払い

Payment method: Malaysia の PaymentId 一覧から iPay88 の支払い方法を 1 つ事前に選択するか、Let the customer choose on the iPay88 page（既定値）のままにします。一覧には Credit Card (MYR)、FPX (Online Banking)、Maybank2U、Alliance Online、AmBank、RHB Bank、Hong Leong Bank、CIMB Clicks、Web Cash、PayPal (MYR)、Credit Card (PHP)、Boost、Touch n Go eWallet、GrabPay、ShopeePay が含まれます。

Reference prefix: 任意です。iPay88 の参照番号（RefNo）で、カート番号の前に付加されます。例：SHOP1-。同じ iPay88 アカウントを使用するストアごとに異なるプレフィックスを設定してください。そうすると、あるストアの応答が別のストアのカートに適用されることがなくなります。使用できるのは英字、数字、「-」、「_」で、最大 10 文字です。保存時にそれ以外の文字は削除され、数字で終わるプレフィックスの末尾には「-」が付加されます。カート番号は RefNo の末尾から読み取られるためです。保存後、ページには保存された値が表示されます。同じ iPay88 アカウントで WooCommerce から PrestaShop に移行する場合は、新しい参照番号が古い注文番号と重複しないようにプレフィックスを設定してください。

Test mode: Charge a fixed test amount instead of the order total。iPay88 には独立したサンドボックスがないため、テスト支払いは iPay88 の本番決済ページで行われる、少額（1.00；IDR 10,000）の実取引です。テスト金額が受け取られると、注文は支払い済みとしてマークされ、注文メモにその旨が記載されます。テストモードがオンの間、チェックアウトには TEST MODE: only a test amount of ... will be charged. と表示されます。テストモードで開始された支払いは、iPay88 が応答する前にテストモードをオフにしても、常にテスト金額に対して照合されます。本番ストアでテストモードをオンのままにしないでください。既定値：オフ。

レスポンス URL と backend URL

モジュールは支払いのたびに両方の URL を送信するため、設定する必要はありません。iPay88 から求められた場合は、このセクションからコピーしてください。フレンドリー URL を使用すると、次のような形式になります：https://your-shop/module/wcp_ipay88_payment/response（Response URL、購入者の戻り）と https://your-shop/module/wcp_ipay88_payment/backend（Backend URL、サーバー間の通知）。必要に応じて /en/ のような言語コードが付くこともあります。このセクションには、iPay88 にリクエスト URL として登録する必要があるサイトのアドレスも表示されます。

iPay88 からの両方の応答は、同じ方法で確認されます：必須フィールド、Merchant Key で作成された署名、そしてこのストアがこのカートに対して開始した支払いの参照番号。有効な署名がない応答は拒否され、カートや注文を変更することは決してありません。backend 通知は、処理後にのみ RECEIVEOK で応答されます。そうしないと iPay88 が再送します。ストアがメンテナンスモードの間も動作し、ストアの国制限によってブロックされることはありません。iPay88 は次の支払いステータスを報告します：

詳細設定

Debug log: 支払いリクエストと iPay88 の応答を、モジュールフォルダー内の logs/ipay88_p_debug.log.php に記録します。このファイルは Web からは開けません。個人データ、Merchant Key、署名は記録されません。エラーと警告は、スイッチがオフでも常に記録されます。既定値：オフ。

Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが消去されます。

Delete data on uninstall: モジュールをアンインストールすると、設定、ログ、iPay88 の支払いデータが削除されます。注文と注文ステータスは削除されません。既定値：オフ。

チェックアウト

支払いの段階で、購入者は支払い方法（既定では iPay88）を選択して確定します。フォームがお住まいの地域の iPay88 決済ページに送信される間、次のページには Redirecting to iPay88 payment gateway... と Please do not close this window. が表示されます。JavaScript が無効な場合、購入者は Pay Now をクリックします。この時点ではまだ注文は存在しません。モジュールは、カートの合計をカートの通貨で（テストモードではテスト金額を）、商品名、購入者の氏名、メールアドレス、電話番号とともに送信します。iPay88 のページでは、購入者はカード、FPX オンラインバンキング、電子ウォレット、またはアカウントで利用可能なその他の方法で支払います。

注文は、購入者の戻り時、または backend 通知のいずれかで、iPay88 が署名付きの応答によって確認した後にのみ支払い済みとしてマークされます。支払いが成功すると注文が作成され、購入者には Your iPay88 payment has been received. を含む標準の注文確認ページが表示されます。保留中の支払いの場合、ページには Your payment is pending confirmation from iPay88. We will update your order as soon as the payment is confirmed. が表示されます。保留中の注文の場合は We have received a payment notification from iPay88 and are reviewing it. We will contact you if anything is needed. が表示されます。注文が Payment error の状態にあるか、キャンセルされた場合は、The payment was not completed. Please contact us. が表示されます。

同じタイミングで backend 通知によって確認が処理されている場合、購入者には We have not received the payment confirmation from iPay88 yet. If you completed the payment, your order will be updated shortly. が、Check again と Back to checkout のボタンとともに表示されます。

支払いに失敗した場合やキャンセルされた場合は、注文は作成されず、カートは保持されます。購入者はチェックアウトに戻り、The payment was not completed: と iPay88 からの理由が表示された後、You can try again or choose another payment method. と表示されます。同じカートでの試行はすべて同じ RefNo を使用します。応答を確認できない場合、購入者には The payment response could not be verified. If you completed the payment, please contact us with your order number — the payment will be checked manually. と、Return to the store ボタンが表示されます。

支払いを開始できない場合、購入者はチェックアウトに戻り、This payment method is temporarily unavailable. Please choose another payment method.（キーが未入力、または合計が 0）または iPay88 cannot accept payments in ... Please choose another payment method.（その地域では通貨を請求できない）が表示されます。カートにすでに注文がある場合（支払い済み、または保留中の支払いを待っている場合）、2 つ目の支払いフォームは生成されず、購入者は注文確認ページに送られます。

本モジュールは 1 回限りの支払いのみに対応しています。PrestaShop からの返金、カードの保存、サブスクリプション、事前承認とキャプチャ、サイト上のカード入力欄には対応していません。支払い状況について iPay88 に再照会することはありません。注文は iPay88 の応答と backend 通知によってのみ更新されます。

注文

Order statuses

No order yet: 購入者は iPay88 に移動しましたが、まだ結果が届いていないか、支払いに失敗しています。カートだけが存在する状態です。

Payment accepted: iPay88 が、想定どおりの金額と通貨で支払いの成功を報告しました。支払いは、iPay88 の TransId を取引 ID として記録されます。非公開のメモには TransID、PaymentID、金額、通貨が表示されます。テストモードでは、2 つ目のメモで注文合計の代わりにテスト金額が請求されたことが示されます。

Awaiting iPay88 payment: iPay88 が支払いを保留中と報告しました。iPay88 が確認すると注文は Payment accepted に移り、失敗した場合は Payment error に移ります。

Payment error: 保留中の支払いがその後失敗しました。メモには iPay88 からの理由が表示されます。このカートにはすでに注文があるため、購入者は再度支払うことができず、新しい注文を行います。

iPay88 payment on hold: iPay88 が、注文と金額または通貨が異なる支払いの成功を報告しました。または、注文がキャンセルされた後に支払いが届きました。注文は支払い済みとしてマークされていません。メモにその理由が説明されています。iPay88 ポータルで支払いを確認し、注文を処理するか、支払いを返金してください。

支払い済みまたは返金済みの注文は、その後の応答によって変更されることは決してありません。その注文に別の支払いの成功が届いた場合は、iPay88 ポータルで確認し、重複であれば返金するよう、メモで通知されます。失敗の応答によって、支払い済み、返金済み、キャンセル済みの注文が変更されることは決してありません。繰り返される応答によって新たな変更が加わることもありません。

iPay88 支払いブロック

注文ページには、RefNo、TransId、ステータス、要求金額、受取金額、PaymentId、AuthCode、エラー、地域を含む iPay88 payment ブロックが表示され、テスト支払いの場合は TEST MODE バッジが表示されます。

返金

返金は PrestaShop から iPay88 に送信されません。iPay88 加盟店ポータルで支払いを返金してから、PrestaShop で返金を手動で記録してください。

ライセンスキー

本モジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox iPay88 Payment は、Modules > Module Manager > VibeFox iPay88 Payment > Configure の最初のブロックで、設定の上にあります。License key にキーを入力し、Activate をクリックしてください。その後、ブロックにはマスクされたキー、ステータス（例: ライセンスの有効期限日とお使いのドメイン）、および次のボタンが表示されます：ステータスを再確認する Check now、別のキーを入力する Change key、このショップからキーを削除する Remove key。その下には Product: presta-payment-ipay88 の行と、vibefox.net アカウントを開くリンク Manage licenses and domains in your account があります。キーを変更できるのは、このモジュールの Configure 権限を持つスタッフだけです。ブロックのテキストは管理画面の言語に従います（英語とロシア語を含みます）。

キーが受け付けられない場合、ブロックにその理由が表示されます。例: Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on。ショップのアドレスを変更した後、またはアカウントでドメインの枠を解放した後に、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認できたステータスで動作を続けます。

1 つのキーは 1 つのドメインで使用できます。メインショップのドメインで、マルチストア構成の場合も同様です。ショップからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで iPay88 はお客様に表示されません。それでも支払いが開始された場合、購入者には This payment method is not available. Please choose another one. と表示されます。PrestaShop のストアフロントは、管理画面にログインしていることを認識できないため、お客様にも支払い方法は表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文は影響を受けません。すでに開始された支払いは引き続き確認されます。

ライセンスの有効期限が切れた場合も、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。管理画面で作業している間、ステータスは自動的に再確認されます。キーの入力後最初の 14 日間は 1 日に 1 回、その後は週に 1 回です。cron ジョブは必要ありません。モジュールのアンインストールまたはリセットを行うと、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

チェックアウトに iPay88 が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、Merchant Code と Merchant Key が入力されていること、そしてカートの通貨が選択した iPay88 region で請求可能であることを確認してください。設定ページには、何かが不足している場合に警告が表示されます。Payment > Preferences で、カートの通貨、購入者の国、購入者のグループに対してモジュールが許可されていることを確認してください。

支払いは完了したが注文が作成されなかった: 購入者の戻りも backend 通知も、有効な署名とともにストアに届いていません。Log フィールドを確認してください。エラーは常に記録されます。Merchant Key が iPay88 から提供されたものと完全に一致すること、そしてサーバーが設定に表示されている Backend URL での iPay88 からのリクエストを受け付けることを確認してください。

iPay88 のページに "Permission not allow" と表示される: サイトのアドレスが iPay88 にリクエスト URL として登録されていません。Response and backend URLs セクションに表示されているアドレスを、iPay88 に登録してもらってください。

backend 通知が BAD SIGNATURE と応答する: 署名が Merchant Key と一致しません。Merchant Key を確認してください。何も変更されていません。

backend 通知が NOT CONFIGURED と応答する: Merchant Code または Merchant Key が設定されていないため、応答を検証できません。iPay88 は通知を再送します。

backend 通知が UNKNOWN ORDER と応答する: このストアでは、この参照番号に対する iPay88 の支払いが開始されていません。たとえば、同じアカウントを使う別のストアが Reference prefix を設定していない、または同じプレフィックスを使っている、あるいはアンインストール時に iPay88 の支払いデータが削除された、などの理由が考えられます。

backend 通知が RETRY と応答する: 同じタイミングで購入者の戻りによってカートの確認が行われていたか、注文を作成できませんでした（たとえばモジュールが無効になっている場合）。iPay88 は通知を再送します。

ブラウザーで Backend URL に BAD REQUEST と表示される: これは正常です。この URL は iPay88 からの署名付きリクエストのみを受け付けます。

注文が iPay88 payment on hold になっている: iPay88 が注文と一致しない支払いを報告したか、注文がキャンセルされていました。注文のメモと iPay88 ポータルの支払いを確認し、注文を完了するか支払いを返金してください。

購入者に通貨付きで "iPay88 cannot accept payments in" と表示される: カートの通貨は、選択した地域では請求できません。iPay88 Malaysia では、MYR 以外の通貨には iPay88 アカウントで複数通貨オプションも必要です。

実際の購入者が 1.00 しか請求されない: Test mode がオンになっています。オフにしてください。

アンインストール

Modules > Module Manager に進み、VibeFox iPay88 Payment の横にあるメニューを開いて、Uninstall を選択します。このモジュールのライセンスキーとライセンスステータスは常に削除されます。確認画面には、Delete data on uninstall が有効でない限り、設定と iPay88 の支払いデータは保持されると表示されます。有効な場合は、設定、ログ、iPay88 の支払いデータが削除されます。無効な場合は、後で再インストールできるようにすべてが保持されます。注文ステータス Awaiting iPay88 payment と iPay88 payment on hold は常に保持されます。注文は削除されず、支払いメモと取引 ID も保持されます。

iPay88 は各所有者の商標です。本モジュールは iPay88 とは提携しておらず、iPay88 による承認も受けていません。