VibeFox GMO for OpenCart — Help

Requirements

OpenCart: 3.0.x (tested on 3.0.5.0) or 4.0.2 and later (tested on 4.1.0.3).

PHP: 8.0 or later.

Currency: Japanese Yen (JPY). GMO-PG charges yen only, so the payment method is shown only when the customer's checkout currency is JPY. Add JPY in System > Localisation > Currencies if your store does not have it yet. The amount is the order total converted with the JPY rate of the store and rounded to whole yen.

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

The download is one zip file with the packages for both OpenCart versions. Unpack it on your computer. It contains README.txt, the OpenCart 3 package wcp_gmo_payment-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_gmo_payment.ocmod.zip. Install only the package for your OpenCart version. The license key is the same for both versions.

OpenCart 3

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_gmo_payment-oc3-(version).ocmod.zip. The extension has no OCMOD modifications, so Extensions > Modifications does not need a refresh. Instead of the installer you can copy the contents of the upload folder of this package into the root folder of your store.

2. Go to Extensions > Extensions and choose the type Payments. Find VibeFox GMO Payment Gateway and click Install (the green + button). Your admin user needs the right to modify the payment extensions list.

3. Click Edit (the pencil button) to open the settings page. Paste your VibeFox license key into License key in the license block at the top of the 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.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_gmo_payment.ocmod.zip. Do not rename the file: OpenCart 4 takes the extension code from the file name, and a renamed package does not work.

2. The package appears in the list of installed extensions on the same page. Click Install (the green + button) next to it.

3. Go to Extensions > Extensions and choose the type Payments. Find VibeFox GMO Payment Gateway, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key, the GMO-PG credentials and the notification URL as in steps 3 to 6 for OpenCart 3. The settings page and its fields are the same in both versions. Only the notification URL is different (see Payment notifications (結果通知)).

A new install starts with the payment method turned off and the test environment selected.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox GMO Payment Gateway > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page warns you when the default currency of the store 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. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must have 1 to 128 characters, Sort Order must be empty or a whole number, Total must be empty or a number of 0 or more, and every order status must exist. If anything is wrong, nothing is saved and the page lists the errors. Spaces around the credentials are removed.

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 customers see at checkout. It is also the payment method name stored in the order. Default: Credit card. Required, up to 128 characters.

Description: the payment method description shown on the Confirm Order step, above the confirm button. Default: You will be redirected to the secure GMO Payment Gateway page to pay by credit card.

Sort Order: the position of the payment method at checkout. Leave it empty or enter a whole number.

Geo Zone: offer the payment method only for payment addresses in the selected geo zone. Default: All zones. Geo zones are set up in System > Localisation > Geo Zones.

Total: the checkout total, in the default currency of the store, that an order must reach before the payment method is offered. Leave it empty to offer it for any total.

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. To remove a saved password, tick Clear the saved password on save under the field and click Save.

Payment

Capture: when the card is charged.

Order status after payment: which status a paid order gets.

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 URL shown in Notification URL in this section. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_gmo_payment/notify, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_gmo_payment/payment/wcp_gmo_payment.notify. It is built from the storefront address of your OpenCart installation. 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 extension 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 payment was made in. The extension 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 extension cannot check a notification, it answers so that GMO-PG sends it again.

Without the notification, an order gets its status only when the customer comes back to the store after paying.

Order statuses

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after GMO-PG has confirmed the payment. Each field lists your OpenCart order statuses. OpenCart has no On hold status, so an authorization or a payment with another amount gets the on hold status below and an order note.

Processing: a paid order when Order status after payment is Processing. Default: Processing.

Completed: a paid order when Order status after payment is Completed. Default: Complete.

GMO-PG payment on hold: authorized only (waiting for the capture) or the amount does not match the order. Default: Pending. You can create your own status in System > Localisation > Order Statuses and select it here.

Cancelled: an authorization or payment on hold cancelled at GMO-PG, or an authorization refunded in full. Default: Canceled.

Refunded: after a full refund from the order page. Default: Refunded.

Advanced

Debug log: writes API requests and notifications to gmo_pg_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web, and at 5 MB it is rotated. Errors and warnings 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 extension removes the gateway settings and the log. Order data (GMO OrderID, transaction IDs) is always kept. Default: off.

Import / Export

Export: Download JSON saves the settings as a JSON file. Shop passwords are not exported.

Import: paste previously exported JSON and click Import to restore the settings. Saved shop passwords are kept.

Checkout

At the Payment Method step the customer chooses the payment method (by default Credit card). At the Confirm Order step the customer sees your description; in the test environment the badge TEST — GMO-PG test environment, no real charges. is shown above it. OpenCart creates the order at this step, still without a status. On OpenCart 4 the customer picks the payment method with the Choose button of the payment method block, in the window Payment method options, and clicks Confirm Order at the bottom of the checkout page. When the customer clicks Confirm Order, the extension creates a GMO-PG Link Type Plus payment for the order total in 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 order. The payment shows at GMO-PG with OC- and the order number. No other customer data is sent.

After paying, the customer returns to your store. 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 payment is never applied twice. The order then gets its status the standard OpenCart way, with the usual order e-mails and stock update, and the customer sees the OpenCart order success 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 the buttons Check again and Back to checkout; the notification sets the order status 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. On OpenCart 4 these messages are shown above the checkout page. Each new attempt (OpenCart 3 creates a new order every time the Confirm Order step is shown, OpenCart 4 updates the order of the checkout) cancels the previous unpaid payment links of the cart. If a previous link was already paid in the meantime, that payment is confirmed and no new link is made.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed without a payment meanwhile (for example it was cancelled at GMO-PG or by you), the customer is sent back to the checkout with Your previous order was cancelled without a payment. Please confirm the order again to pay with a new order., and the next Confirm Order pays a new order of the cart. If that order is already paid but the cart has changed since, including a new quantity, the message is Your previous order has already been placed. Your cart has changed since — please confirm the order again to pay for the current cart with a new order. A paid order is never shown as paid for a different cart.

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 stays at the Confirm Order step with a short message above the button, 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 also work while the store is in maintenance mode, because OpenCart 3 lets payment extension requests through and the extension adds a startup action for them on OpenCart 4.

The extension 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 status (missing order): the customer was sent to GMO-PG and has not paid, or GMO-PG has not confirmed the payment yet. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

Processing or Completed status: the payment was confirmed; the status follows Order status after payment. 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 gets the paid status. If the authorization is cancelled at GMO-PG, the order gets the Cancelled status.

GMO-PG payment on hold after payment: GMO-PG reported a different amount than the order total. The note explains it. Check the order and fulfil it or refund the payment.

Refunded: the payment was fully refunded through the extension. A full refund of an authorization that was never captured sets the Cancelled status.

If a second payment arrives for an order that is already paid, or for the same cart under another order, the paid order is not changed. A note asks you to refund the duplicate in the GMO-PG console. If a payment arrives for an order that already has a status without a GMO-PG payment, only a note is added.

Notes are entries in the order History that the customer does not see.

VibeFox GMO Payment Gateway tab

In Sales > Orders open an order paid with GMO-PG. At the bottom of the order page, next to History and Additional, the VibeFox GMO Payment Gateway tab shows the GMO OrderID (with a TEST label for test payments), the Transaction ID, the Status with the GMO-PG status, Paid / refunded, the capture button and the refund form, the refund history and the GMO-PG notes of the order. The tab is shown to users who have access to the extension; capture and refunds need the right to modify it (set in System > Users > User Groups).

Capture

Capture payment (GMO-PG) appears in the tab of an order on hold that was authorized only. Confirm Capture the authorized GMO-PG payment? The extension checks the transaction at GMO-PG and charges the authorized amount; the order then gets the paid status. If the transaction is no longer authorized, for example because it was already captured in the GMO-PG console, the message shows the current status. A capture made in the GMO-PG console arrives by the result notification.

Refunds

In the tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), 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 tab 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 Refunded status without notifying the customer and without returning products to stock, like a manual status change. A partial refund does not change the status.

Product returns in Sales > Returns 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 is not changed automatically, except for an authorization or payment on hold cancelled at GMO-PG. Update it manually if needed.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox GMO Payment Gateway is the first block on Extensions > Extensions > Payments > VibeFox GMO Payment Gateway > Edit, 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 store. Below them are the line Product: opencart-payment-gmo and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only admin users with the Modify permission for the extension can change the key. The texts of the block follow the admin 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 store address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the extension keeps working on the last known status.

One key works on one domain: the store address from the OpenCart configuration. Removing the key from the store 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. An admin user who is logged in to the admin in the same browser still sees the payment method in the store, marked (unlicensed — visible to admins only), so you can set up and test the extension before you buy a key. On OpenCart 4 this preview is not available: the store does not see the admin login, so without an active key the payment method is hidden for everybody. After you have opened the Edit page once, a reminder appears on the admin Dashboard. Close it with × to hide it for 7 days. Existing orders are not affected: payments already started are still confirmed, and captures and refunds work.

When a license expires, the extension keeps working, but updates and support need a renewal. The status is checked again automatically when you open the admin Dashboard or the Edit page: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling the extension 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 checkout currency is JPY and the current environment has its Shop ID, Shop password and Config ID. 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. Also check that the payment address is in the selected Geo Zone and that the order reaches the Total set in the settings.

The payment went through, but the order stays without a status: 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 extension verifies each notification with them. Turn on Debug log and look at the Log field on the extension page. The order also gets its status 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: OrderID 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 payment and the other way round.

The customer sees an error after Confirm Order: 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. This payment method is not available at the moment. Please choose another payment method. means the checkout session no longer matches the order or the payment method was turned off meanwhile: the customer reloads the checkout.

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

Refund or capture fails: read the message in the tab. 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 tab shows You do not have permission to refund orders.: your user group has no right to modify the extension. Ask an administrator to grant it in System > Users > User Groups.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox GMO Payment Gateway. The license key and license status of this extension are always removed. OpenCart always removes its own settings of the extension: Enable/Disable, Sort Order, Geo Zone, Total and the fields of the Order statuses section, which return to their defaults on a re-install. On OpenCart 4 the event of the extension (the checkout message) and its startup action, which lets the notification and the return through in maintenance mode, are removed too. If Delete data on uninstall is on, the other gateway settings (title, description, environment, credentials, capture, order status after payment, debug log switch) and the log are removed. If it is off, they are kept for a later re-install. The GMO-PG transactions and refunds are always kept, so orders paid before can still be captured and refunded after a re-install. Existing orders keep their payment notes.

On OpenCart 4, to remove the files of the extension as well, go to Extensions > Installer after the uninstall and click Uninstall (the orange − button) next to VibeFox GMO Payment Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

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