VibeFox GMO for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later. The module refuses to install on older PHP versions.

Currency: Japanese Yen (JPY). GMO-PG charges yen only, so the payment method is shown only when the cart currency is JPY. Add JPY in International > Localization > Currencies if your shop does not have it yet.

GMO Payment Gateway account: a GMO-PG merchant contract with Link Type Plus. You need the Shop ID, the Shop password and the Link Type Plus Config ID (設定ID) of the test and/or production environment, and the result notification (結果通知) turned on in the GMO-PG shop console (see Configuration). The Site ID and Site password are not used.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.

2. When the upload finishes, click Configure, or find VibeFox GMO Payment Gateway in the module list later and click Configure.

3. Paste your VibeFox license key into License key in the license block at the top of the Configure page and click Activate (see License key).

4. Enter the Shop ID, Shop password and Config ID of the test and/or production environment and choose the Environment.

5. In the GMO-PG shop console turn on 結果通知 (result notification) and set the notification URL shown in the settings (see Configuration).

6. Turn on Enable/Disable and click Save. Make a test payment in the test environment, then switch Environment to production.

On install the module creates the order status GMO-PG payment on hold. PrestaShop offers a new payment module for all currencies, countries and customer groups. You can limit them in Payment > Preferences; JPY must stay allowed.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox GMO Payment Gateway > Configure. Every Save button saves the whole page. Above the fields the page warns you when the default currency of the shop is not JPY and when the Shop ID, Shop password or Config ID of the current environment is missing (the payment method is then hidden at checkout). It also shows which environment is active: TEST — payments go to pt01.mul-pay.jp with the test credentials, no real money is charged. or PRODUCTION — payments go to p01.mul-pay.jp. Spaces around the credentials are removed when you save.

GMO Payment Gateway — Credit Card

Enable/Disable: Enable GMO Payment Gateway — Credit Card turns the payment method on or off. Default: off.

Title: the payment method name shown at checkout. It is also the payment method name stored in the order. Default: Credit card. Required.

Description: the text shown under the payment method at checkout. Default: You will be redirected to the secure GMO Payment Gateway page to pay by credit card.

GMO-PG account

The Shop ID and Shop password are in the GMO-PG shop console under Shop management > Shop information, the Config ID under Link Type Plus > Settings (設定ID). The test and production environments have different credentials.

Environment: which GMO-PG environment takes new payments.

Production Shop ID: the Shop ID of the production environment.

Production Shop password: the Shop password of the production environment.

Production Config ID: the Link Type Plus config ID (設定ID) registered in the GMO-PG console.

Test Shop ID: the Shop ID of the test environment.

Test Shop password: the Shop password of the test environment.

Test Config ID: the Link Type Plus config ID (設定ID) of the test environment.

Saved passwords are never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it.

Clear saved passwords: tick a password and click Save to remove it. An empty field keeps the saved value.

Payment

Capture: when the card is charged.

Order status after payment: the status of a paid order.

Payment notifications (結果通知)

The result notification tells your shop that a payment has been made. It is required. In the GMO-PG shop console turn on 結果通知 (result notification) and set the URL shown in Notification URL in this section. With friendly URLs it looks like https://your-shop/module/wcp_gmo_payment/notify, possibly with a language code such as /ja/. Copy the URL exactly as the settings show it. It must be reachable from the Internet; maintenance mode does not block it.

GMO-PG notifications are not signed, so the module never trusts their content. The notification must come from one of your configured Shop IDs and refer to a payment created by this shop, in the environment the payment was made in. The module then asks GMO-PG for the transaction (SearchTrade) with your Shop password and changes the cart or order only from that answer. A notification that does not match a real transaction changes nothing. Transactions not created by the shop, for example ones made in the GMO-PG console, are acknowledged and ignored. When the module cannot check a notification, it answers so that GMO-PG sends it again (GMO-PG retries up to 5 times).

Without the notification, an order is created only when the customer comes back to the shop after paying.

Advanced

Debug log: writes API requests and notifications to logs/gmo_pg_debug.log.php in the module folder. The file cannot be opened from the web. Errors are always logged, even while the switch is off. Passwords and customer data are masked. Default: off.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Delete data on uninstall: when on, uninstalling the module removes the gateway settings and the log. Order data (GMO OrderID, transaction IDs) is always kept. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default Credit card) and sees its description. In the test environment the badge TEST — GMO-PG test environment, no real charges. is shown above it. After confirming, the module creates a GMO-PG Link Type Plus payment for the cart total, rounded to whole yen, and sends the customer to the GMO-PG payment page. There the customer pays by credit card. 3-D Secure 2.0 is handled by GMO-PG, and the customer's e-mail is passed to it for 3-D Secure. The payment page opens in Japanese, Chinese or English, following the language of the customer. The payment shows at GMO-PG with PS- and the cart number. No other customer data is sent. No order exists yet at this point.

After paying, the customer returns to your shop. The signed result is checked with the Shop password of the payment's environment, and the order is marked paid only after GMO-PG confirms it: by a server-side SearchTrade request when the customer returns, or by the result notification. Both use the same logic, so the order is never created twice. The customer then sees the standard order confirmation page. If GMO-PG has not confirmed the payment yet, a Payment confirmation page shows Your card payment is being confirmed by GMO Payment Gateway. You will receive an e-mail as soon as it is confirmed. with a Check again button; the notification creates the order as soon as it arrives.

If the card is declined or the payment fails on the GMO-PG page, the customer is back at checkout with The card payment was declined or could not be completed. Please try again or use another card. If the customer leaves the GMO-PG page without paying, the message is The payment was not completed. You can try again or choose another payment method. The cart is kept. Each new attempt cancels the previous unpaid payment link. If the previous link was already paid in the meantime, the order is created from that payment and no new link is made.

Cart totals from 1 to 9,999,999 JPY can be paid. Larger totals hide the payment method. If the payment cannot be started, the customer stays at checkout with a short message, for example Card payment could not be started. Please try again or choose another payment method., and the reason is written to the log.

The notification and the return work while the shop is in maintenance mode and are not blocked by the country restriction of your shop.

The module takes credit card payments in JPY only, always on the GMO-PG page. It has no other GMO-PG payment methods, no multi-currency, no saved cards or GMO-PG member registration, no subscriptions or recurring billing and no on-site card form.

Orders and refunds

Order statuses

No order yet: the customer was sent to GMO-PG and has not paid, or GMO-PG has not confirmed the payment yet. Only the cart exists.

Payment accepted or Delivered: the payment was confirmed. The status follows Order status after payment. The payment is recorded with the GMO-PG TranID as the transaction ID, and a note shows the amount, the GMO-PG status, the transaction and how it was confirmed (notification or return).

GMO-PG payment on hold (authorized): with Authorize only (仮売上) the amount was authorized. Capture it with Capture payment (GMO-PG) or in the GMO-PG console before the authorization expires. After the capture the order becomes Payment accepted or Delivered. If the authorization is cancelled at GMO-PG, the order becomes Canceled.

GMO-PG payment on hold after payment: GMO-PG reported a different amount than the cart total, or the cart was not in JPY. The note explains it, and the payment is recorded for the amount GMO-PG actually took. Check the order and fulfil it or refund the payment.

Refunded: the payment was fully refunded through the module. A full refund of an authorization that was never captured sets Canceled.

If a second payment arrives for a cart whose order is already paid or closed, the order is not changed. A note asks you to refund the duplicate in the GMO-PG console.

GMO Payment Gateway block

The order page shows a GMO Payment Gateway block with the GMO OrderID, the Transaction ID, the status (with the GMO-PG status), Paid / refunded, a TEST badge for test payments, the refund history and the GMO-PG notes of the order. Capture and refunds need the right to edit orders; access to the Modules pages is not needed.

Capture

Capture payment (GMO-PG) appears in the block of an order on hold that was authorized only. Confirm Capture the authorized GMO-PG payment? The module checks the transaction at GMO-PG and charges the authorized amount. If the transaction is no longer authorized, for example because it was already captured in the GMO-PG console, a note shows the current status and the order follows it.

Refunds

In the block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via GMO-PG. Confirm Refund this amount through GMO-PG? Full and partial refunds are supported, in whole yen. The limit is the amount GMO-PG actually took and still holds, not the order total. Refunding the whole remaining amount cancels the GMO-PG transaction, and GMO-PG decides whether it is a void or a return. A partial refund lowers the transaction amount. The refund is sent to the environment the payment was made in, so that environment's Shop ID and Shop password must be set. If GMO-PG does not accept the refund, the block shows the error and no refund is recorded. A successful refund is added to the refund history and the notes. A full refund sets the order to Refunded; a partial refund does not change the status.

The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through GMO-PG.

Refunds and cancellations made in the GMO-PG console arrive by the result notification and are added to the notes. The order status and credit slips are not changed automatically, except for an authorization cancelled at GMO-PG. Update them manually if needed.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox GMO Payment Gateway is the first block on Modules > Module Manager > VibeFox GMO Payment Gateway > Configure, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this shop. Below them are the line Product: presta-payment-gmo and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.

One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, the GMO-PG credit card payment is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. The PrestaShop storefront does not know that you are logged in to the back office, so the payment method is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected: payments already started are still confirmed, and captures and refunds work.

When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module always removes the license key and license status.

Troubleshooting

Credit card does not appear at checkout: check that the license is active, Enable/Disable is on, the cart currency is JPY and the current environment has its Shop ID, Shop password and Config ID. Cart totals above 9,999,999 JPY cannot be paid by card. The settings page shows a warning when the currency or the credentials are wrong. In Payment > Preferences check that the module is allowed for JPY, the customer's country and the customer's group.

The payment went through, but no order was created: the result notification is not working. In the GMO-PG shop console of the environment you use, check that 結果通知 is on and that the URL is exactly the one shown in Notification URL. Check that the Shop ID and Shop password of that environment are filled in, because the module verifies each notification with them. Turn on Debug log and look at the Log field on the module page. The order is also created when the customer returns to the shop after paying.

Log shows Notification rejected: unknown ShopID: the notification came from a shop whose Shop ID is not in the settings. Enter the Shop ID of that environment.

Log shows Notification ignored: OrderID is not a payment of this store: the transaction was not created by this shop, for example it was made in the GMO-PG console. Nothing needs to be done.

Log shows that the cart was paid in another environment: test and production payments are kept apart. A test notification never confirms a production payment and the other way round.

Log shows Cannot create the order: the module is disabled: the module was disabled while a payment was being confirmed. Enable it; GMO-PG sends the notification again.

The customer sees an error when choosing the card payment: turn on Debug log and look at the Log field. The log shows the GMO-PG error code (ErrCode, ErrInfo). A wrong Shop ID, Shop password or Config ID is the usual reason. GMO Payment Gateway accepts payments in Japanese Yen (JPY) only. means the cart is not in JPY.

Order is GMO-PG payment on hold: read the notes in the GMO Payment Gateway block. The order was authorized only and waits for capture, or the paid amount differed from the cart.

Refund or capture fails: read the message in the block. The order may have been paid in the other environment, whose Shop ID and password are not set, the transaction may already be cancelled at GMO-PG, or the amount may exceed what is left on the transaction. The order is being updated by GMO-PG right now. Try again in a moment. means a notification was being processed at the same time.

The block shows You do not have permission to refund orders.: your employee profile has no right to edit orders. Ask an administrator to grant it.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox GMO Payment Gateway and choose Uninstall. The license key and license status of this module are always removed. If Delete data on uninstall is on, the gateway settings and the log are removed. If it is off, all settings are kept for a later re-install. The GMO-PG transactions and refunds and the order status GMO-PG payment on hold are always kept, so orders paid before can still be captured and refunded after a re-install. Existing orders keep their payment notes and transaction IDs.

GMO Payment Gateway is a trademark of its respective owner. This module is not affiliated with or endorsed by GMO Payment Gateway.