Adobe Commerce (Magento)

Adobe Commerce (Magento) is an e-Commerce platform built on open source technology which provides online merchants with a flexible shopping cart system, as well as control over the look, content and functionality of their online stores. Magento offers powerful marketing, search engine optimization, and catalog-management tools. Magento's ability to scale allows shops with only a few products and simple needs to easily expand to tens of thousands of products and complex custom behavior without changing platforms.

---

Requirements

Before integrating your Magento store with DOKU, please ensure that the following requirements have been met:

1. Create a store with Magento

2. Create a DOKU Business Account

3. Magento v2.3 or higher. This plugin is tested with Magento v2.3.4, v.2.3.6, v.2.4.0, v.2.4.1

4. PHP v7.4.0 or higher

5. MySQL v8.0 or higher

---

Integration Guide

Step 1: Install DOKU Plugin for Magento

1. Download DOKU Plugin for Magento

2. Copy Jokul folder into your MAGENTO_DIR/app/code directory on your store's webserver.

3. Run php bin/magento module:status. You should see Jokul_Magento2 on list of disabled modules.

4. Run php bin/magento module:enable Jokul_Magento2

5. Run php bin/magento setup:upgrade

6. Run php bin/magento module:status again to ensure Jokul_Magento2 is enabled already.

7. Flush Magento cache by running php bin/magento cache:flush

8. Compile Magento with newly added module by running php bin/magento setup:di:compile

9. Flush Magento cache again php bin/magento cache:flush​

Step 2: Plugin Setup

1. Log in to your Magento Admin Panel

2. Navigate to Stores > Configuration

3. Go to Sales > Payment Methods

4. Locate DOKU section

5. Click the dropdown arrow icon to view the details

6. Configure the following required fields:

   • Environment:

     • For testing transactions, select Sandbox

       • Sandbox Client ID: Client ID retrieved from DOKU Sandbox

       • Sandbox Secret Key: Secret Key retrieved from DOKU Sandbox

     • For processing real transactions, select Production

       • Production Client ID: Client ID retrieved from DOKU Dashboard

       • Production Secret Key: Secret Key retrieved from DOKU Dashboard

   Visit API Keys for instructions on how to retrieve integration credentials (Client ID and Secret Key)

   • Expiry Time: Expiration time in minutes

   • Notification URL: Payment notification URL for all payment methods

   • QRIS Notification URL: Payment notification URL for QRIS payment method

   • Email Sender Address: You can fill this column with your email address. This will later be used as info to send notifications to your customers

   • Email Sender Name: You can fill this column with your name. This will be used to email send notifications to your customers

   • CC Email Adress: You can fill this column other email adress. This will be used to email send notifications to your customers

   • Email Notifications: You can send an email containing a guide on how to complete the payment using specific payment methods

7. Click Save Config

Step 3: Set Up Payment Notification on DOKU Dashboard

If you skip this step, your payment status on Magento Admin Panel will not be synced with DOKU Dashboard

1. Copy the Notification URL from the Magento Admin Panel

2. Log in to your DOKU Dashboard

   • For testing transactions, visit DOKU Sandbox

   • For processing real transactions, visit DOKU Dashboard

3. Navigate to Settings > Payments Settings, then go to each payment method settings page

1. Set up the payment notification URL for each payment method that you have activated. Visit Set Up Payment Notification for instructions

Once payment notification has been configured, you can start accepting payments with DOKU.

---

Checkout Page Configuration

By configuring your checkout page, you will be able to:

1. Show or hide, and sort payment methods for your customers Choose which payment methods (e.g., cards, e-wallets, and virtual accounts) tp appear on your checkout page. You can also reorder them based on your preference or customer behavior to optimize conversions.

2. Customize the interface Adjust the look and feel of your checkout page to align with your brand. This includes modifying button colors, fonts, logos, and layout to ensure a seamless and branded customer experience.

3. Set a default expiry time Define how long a payment session remains valid before it expires. This is useful for limiting pending transactions and encouraging quicker payments, especially for methods like virtual accounts or retail outlets.

Visit Customize Checkout Page for more detailed information.

---

Error Log

​Error log, also known as doku_log, helps simplify the process of identifying issues related to the payment process when using the DOKU Plugin. If any issues arise while using the plugin, you can contact our support team and provide the doku_log file to assist with troubleshooting. The doku_log file records all transaction activity by date, regardless of the payment method used.

How to Enable and Access the doku_log:

1. Open the MAGENTO_DIR directory on your store’s web server.

2. Create a new folder named doku_log in your store’s directory. This enables the plugin to automatically log activity to your web server.

3. Navigate to the doku_log folder and open the log file corresponding to the date of the issue.

4. You can view or download the log file as needed.

If an issue occurs, please send the relevant doku_log file to our support team. This helps us investigate and resolve the issue more efficiently.

---

FAQ

How to retrieve my integration credentials (Client ID and Secret Key) ?

Please refer to the guide on API Keys to obtain your integration credentials.

Why is my payment status not updated on Magento Admin Panel?

Payment notification URL must be set up on DOKU Dashboard for the transaction status to be updated on Magento Admin Panel. Please be sure to not skip step number 3 in the Integration Guide section.