Magento 2 integration guide

Once you’ve installed and activated the iwocaPay plugin, it will integrate as a payment option in your Magento checkout. Payments made through iwocaPay will automatically reconcile with your store data to simplify your workflow.

With just a few clicks, you can offer Buy Now, Pay Later to your customers. Optionally, you can also include a Pay Now option powered by instant bank-to-bank transfers at no extra cost or effort.

---

Before You Begin

Installing the iwocaPay extension for Magento takes 1–2 hours. You’ll likely need a developer or someone with command-line access.

Supported versions

The iwocaPay extension is not compatible with Magento 1.

Prerequisites

• Access to your server’s command line
• Your iwocaPay API keys — contact your account manager to obtain them
• Back up your database before making any changes
• Run installation commands in maintenance mode

Choose your pricing structure

With iwocaPay, you decide who covers the cost of Pay Later transactions.

You can manage your pricing preferences from your universal pay link in the iwocaPay dashboard.

Read more about our pricing structure

---

Installing iwocaPay in Magento 2

Caution

If you need to refresh your API keys, please note this is only required for Production and your staging keys will remain unchanged.

1. Access your Magento server via SSH and navigate to your Magento 2 installation directory:

   cd /path/to/magento

   composer config repositories.iwoca git "git@github.com:iwoca/iwocapay-magento-payment-gateway.git"

2. Download the plugin files:

   composer require iwoca/iwocapay-magento

3. Enable and install the plugin:

   magento module:enable Iwoca_Iwocapay
   magento setup:upgrade
   magento cache:clean && magento setup:di:compile

4. Configure the plugin:

   Caution

   Make sure you are editing the Default Config scope when configuring iwocaPay. In the Magento admin, go to the Store View dropdown at the top-left of the Configuration page and check it says “Default Config”, not a specific website or store view.

   iwocaPay supports one seller account per Magento installation. Configuration must be saved at the default (global) level to work correctly across all your websites and store views.

   If you have more than one website or store view, don’t re-save the iwocaPay configuration while it’s scoped to a specific website. If you do it’ll create a website-level override that can cause payment failures and order reconciliation issues.

   • Log in to your admin panel at /admin.
   • Navigate to Stores > Configuration (make sure default config is selected) > Sales > Payment Methods.
   • Select iwocaPay Payment Method and configure the following:
     • Enabled: Yes
     • Seller Access Token: <Your key>
     • Seller ID: <Your ID>
   • Set Mode to Production mode.
   • Click Save Config

5. Clear your cache:

   magento cache:flush

Testing your setup

• Add items to your basket and proceed to checkout.
• Confirm that iwocaPay is now available as a payment option.

Updating the iwocaPay plugin

To take advantage of the latest features, update the plugin regularly.

1. SSH into your server and navigate to the Magento 2 directory:

   cd /path/to/magento

2. Run the following command to update:

   composer require iwoca/iwocapay-magento:^VERSION_NUMBER

   Tip

   If you encounter issues, you can specify the latest commit hash from the iwocaPay GitHub repository:*

   composer require iwoca/iwocapay-magento:dev-master#COMMIT_HASH

3. Apply the update:

   composer update iwoca/iwocapay-magento --with-dependencies

4. Clear cache and update dependencies:

   magento setup:upgrade
   magento cache:clean && magento setup:di:compile

Configuring payment options

You can customise which iwocaPay options are available to customers:

• Pay Later
• Pay Now (always free for both you and your customers).

Updating your options

• Log in to your admin panel at /admin
• Go to Stores > Configuration > Sales > Payment Methods
• Select iwocaPay Payment Method.
• Use the Payment modes drop-down menu to choose your preferred options.
• Changes will update automatically.

Removing iwocaPay

If you need to remove iwocaPay from your checkout, follow these steps:

• Enable maintenance mode on your server.
• Disable the extension, update dependencies, and clear your cache.
• Verify the removal.
• Remove the module files from the app directory.
• Disable maintenance mode.

To reinstall iwocaPay in the future, you’ll need to follow the installation steps again.