VibeFox GMO for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

WooCommerce: 8.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

Store currency: Japanese Yen (JPY). With another store currency the payment method is hidden at checkout. On the Pay for order page the order currency counts.

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 WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the wcp_gmo_payment folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card > Manage, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate.

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

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

7. Turn on Enable/Disable. Make a test payment in the test environment, then switch Environment to production.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card. The page title shows a TEST or PRODUCTION badge for the current environment. Above the fields the page warns you when the store currency is not JPY and when the Shop ID, Shop password or Config ID of the current environment is missing. In both cases the payment method is hidden at checkout. In the list of payment methods the gateway is marked as needing setup until the current environment has its credentials. Spaces around the credentials are removed when you save.

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. Default: Credit card.

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 the payments.

Production credentials (p01.mul-pay.jp)

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 credentials (pt01.mul-pay.jp)

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.

Payment

Capture: when the card is charged.

Order status after payment: the status of a paid order. The status is set at once, with one status change and one customer e-mail.

Payment notifications (結果通知)

The result notification tells your store that a payment has been made. It is required. In the GMO-PG shop console turn on 結果通知 (result notification) and set the notification URL shown in this section of the settings. It looks like https://your-site/wc-api/gmo_pg_webhook/. Copy the URL exactly as the settings show it.

GMO-PG notifications are not signed, so the plugin never trusts their content. The notification must come from one of your configured Shop IDs and refer to a payment created by this store, in the environment the order was paid in. The plugin then asks GMO-PG for the transaction (SearchTrade) with your Shop password and changes the order only from that answer. A notification that does not match a real transaction changes nothing. Transactions not created by the store, for example ones made in the GMO-PG console, are acknowledged and ignored. When the plugin 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 confirmed only when the customer comes back to the store after paying.

Advanced

Debug log: Log API requests and notifications writes them to WooCommerce > Status > Logs, source wcp_gmo_payment. Errors are always logged. Passwords and customer data are masked. Default: off.

Delete data on uninstall: Delete the gateway settings and logs when the plugin is deleted. Deactivation never deletes anything. Order data (transaction IDs) is always kept. Default: off.

Checkout

The customer chooses the payment method (by default Credit card) and places the order. The plugin creates a GMO-PG Link Type Plus payment for the order 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 billing e-mail is passed to it for 3-D Secure. The payment page opens in Japanese, Chinese or English, following the language of your site. The payment shows at GMO-PG with WC- and the order number. No other customer data is sent.

After paying, the customer returns to your store. The signed result is checked with your Shop password, 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 processed twice. If the payment is not confirmed yet, the order received page shows Your card payment is being confirmed by GMO Payment Gateway. You will receive an e-mail as soon as it is confirmed.

If the card is declined or the payment fails on the GMO-PG page, the order becomes Failed and the customer is taken to the Pay for order page with the message 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 same page shows The payment was not completed. You can try again or choose another payment method. Each new attempt cancels the previous unpaid payment link. If the previous link was already paid in the meantime, that payment is applied and no new link is created.

Order 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 sees a short message, for example Card payment could not be started. Please try again or choose another payment method., and the reason is added to the order notes.

The payment method works on the classic checkout, on the Cart and Checkout blocks and on the Pay for order page. On the Checkout block it shows the card icon and the description. In the test environment both the classic checkout and the Checkout block show the badge Test mode — no real charge. It is compatible with WooCommerce High-Performance Order Storage (HPOS).

The plugin 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

Pending payment: the customer was sent to GMO-PG and has not paid yet, or GMO-PG has not confirmed the payment yet.

Processing or Completed: the payment was confirmed. The status follows Order status after payment. The order note shows the amount, the GMO-PG status, the transaction and how it was confirmed (notification or return). The transaction ID is the GMO-PG TranID.

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

On hold after payment: GMO-PG reported a different amount than the order total, or the payment arrived after the order had been cancelled. The order note explains it. Check the order and fulfil it or refund the payment.

Failed: the card was declined or the payment was not completed on the GMO-PG page.

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

Capture

The order action Capture payment (GMO-PG) appears on on-hold orders that were authorized only. It charges the authorized amount. If the transaction is no longer authorized, for example because it was already captured in the GMO-PG console, the action adds a note with the current status and follows it.

Refunds

Open the order, click Refund, enter the amount and click Refund via Credit card (the button shows your Title). Full and partial refunds are supported, in whole yen. 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, and the card company authorizes the new amount. The refund is sent to the environment the order was paid in, so that environment's Shop ID and Shop password must be set. If GMO-PG does not accept the refund, WooCommerce shows the error and no refund is recorded. A successful refund is added to the order notes.

Refunds and cancellations made in the GMO-PG console arrive by the result notification and are added to the order notes. They are not recorded as WooCommerce refunds automatically. If needed, create a manual refund in WooCommerce without the GMO-PG button.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > GMO Payment Gateway — Credit Card. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, the payment method 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. Logged-in store managers still see the payment method, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected: payments already started are still confirmed, and refunds and captures work.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

Credit card does not appear at checkout: check that the license is active, Enable/Disable is on, the store currency is JPY and the current environment has its Shop ID, Shop password and Config ID. Order 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.

The payment went through, but the order stays Pending payment: 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 the settings. Check that the Shop ID and Shop password of that environment are filled in, because the plugin verifies each notification with them. Turn on Debug log and look at WooCommerce > Status > Logs, source wcp_gmo_payment. The order is also confirmed when the customer returns to the store 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 ... is not a payment of this store: the transaction was not created by this store, for example it was made in the GMO-PG console. Nothing needs to be done.

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

The customer sees an error when placing the order: open the order notes or turn on Debug log. The note 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 order is not in JPY.

Order is On hold after payment: read the order note. The order was authorized only and waits for capture, the paid amount differed from the order, or the payment came after the order was cancelled.

Refund fails: read the message. 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 license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all data. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin are always removed. The gateway settings and the logs are removed only if Delete data on uninstall was on. Otherwise they stay for a later re-install. The GMO-PG data stored on orders is payment history and is always kept. Existing orders keep their payment notes and transaction IDs.

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