【EC-CUBE】Getting Started with EC-CUBE (Setup Guide)
Setting up KOMOJU on EC-CUBE (version 4.2/4.3) follows this order: get the plugin from the Owner's Store → enter your API credentials → sync payment methods.
Prerequisites
- A KOMOJU account (sign up here if you don't have one yet)
- Live Mode activated on your KOMOJU account
- Admin access to your EC-CUBE store
- Basic familiarity with the EC-CUBE admin panel
Supported Version
The KOMOJU Payment plugin supports EC-CUBE 4.2/4.3.
Getting the Plugin (Owner's Store)
The KOMOJU Payment plugin is distributed through the EC-CUBE "Owner's Store." The steps follow the same flow as any other EC-CUBE plugin obtained through the Owner's Store.
- Register as an Owner's Store member (one-time step, if not already registered)
- From your Owner's Store account page, register your site URL and obtain an authentication key (one-time step)
- Register the authentication key in your EC-CUBE admin panel (one-time step)
- From "Find Plugins" in the Owner's Store, select the "KOMOJU Payment plugin" and proceed with the acquisition steps
- On the "Plugin List" screen in your EC-CUBE admin panel, click "Install" next to the KOMOJU Payment plugin that now appears there
- Click the "▶" (enable) icon next to the installed plugin under "Owner's Store Plugins" in the Plugin List
- Once enabled, "KOMOJU Payment" appears in the left sidebar navigation
Detailed screen-by-screen installation and activation steps are covered in the next article.
Setup Overview
Here is the overall flow to go live:
- Prepare your KOMOJU account and confirm your Live Mode application status
- Get, install, and enable the KOMOJU Payment plugin (via the Owner's Store)
- Enter your API credentials (Merchant ID, Secret Key, Publishable Key)
- Sync payment methods, and link payment methods to delivery methods
- Configure webhooks
- Set the capture mode (Authorize and Capture / Authorize Only)
- Run a test payment in Test Mode to verify the integration
- Switch to Live Mode and go live
How the KOMOJU Payment Plugin Works
The KOMOJU Payment plugin uses a single plugin that handles all payment methods. You install the plugin once, enter your API credentials, and then sync your available payment methods directly from the plugin settings page.
Here's how a payment works end-to-end:
- A customer reaches the checkout page on your EC-CUBE store
- The payment methods you've enabled appear as options
- The customer selects a method and is redirected to KOMOJU's hosted payment page to complete the transaction
- KOMOJU processes the payment and notifies EC-CUBE via webhook
- The EC-CUBE order status updates automatically
About Sensitive Payment Data
No sensitive payment data (credit card numbers, etc.) passes through your EC-CUBE server. All payment processing happens on KOMOJU's PCI-compliant hosted page.
Detailed Setup Guides
For detailed setup steps, see the following guides:
- Installing and Enabling the Plugin
- Getting and Configuring Your API Keys (Live / Test)
- Configuring Webhooks
- Verifying Your Integration in Test Mode (Test Payments)
- Configuring Payment Methods (Enable, Disable, Display)
For common questions and troubleshooting after launch, see the following operational guides:
- Matching EC-CUBE Orders with KOMOJU Transactions
- How KOMOJU Payment Statuses Map to EC-CUBE Order Statuses
- Handling Expired (Unpaid) Orders
- How to Cancel or Refund a Payment (Credit Card / Mobile Payment, etc.)
- How to Cancel or Refund a Payment (Bank Transfer / Convenience Store / Pay-easy)
- Refund Status Sync and Settlement Timing