Magento 2 OAB iPay

Magento 2 OAB iPay integrates Magento 2 store with Oman's popular OAB iPay payment gateway to capture secure online payments.

 

Table of Content

  1. Extension Installation
  2. Gateway File Upload
  3. Configuration
  4. OAB iPay Method in Frontend
  5. OAB iPay Details in Backend

 

  1. Extension Installation
  • For Magento Marketplace Customers
  • Create a folder structure in Magento root as app/code/Meetanshi/Oab
  • Download and extract the zip folder and upload our extension files to the app/code/Meetanshi/Oab via FTP.
  • Login to your SSH and run below commands step by step:
  • php bin/magento setup:upgrade
  • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
  • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
  • php bin/magento cache:flush

 

  • For Meetanshi Customers
  • Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
  • Login to your SSH and run below commands step by step:
  • php bin/magento setup:upgrade
  • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
  • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
  • php bin/magento cache:flush

 

 

  1. Gateway File Upload
    After installation of the extension, login to https://certpayments.oabipay.com/mrch/merchantLogin.htm with your credentials. Move to Merchant Process > Resource File Download. Download both the PHP KeyStore and Resource File and upload them into your Magento root under the folder name “oab”. If the folder isn’t available in the root, create one name “oab” and upload these files there. If the folder and files already available, update both of these files with the existing ones.

 

  1. Configuration
    To configure the extension, login to Magento 2, move to Sales à  Payment Methods à OAB iPay - Meetanshi where you can find various settings to enable the extension.
  • Enabled: Set “YES” to enable the OAB iPay method.
  • Title: Set the title for the payment method to be displayed in the frontend.
  • Show OAB Logo: Set YES to show OAB logo along with the payment method in the frontend.
  • Alias: Enter the alias provided by OAB iPay gateway while registration.

 

    • Move to the “Plugin” tab where you can see “Terminal Alias Name”. Copy its value and paste here.

  • Payment Language: Set the language of the payment.
  • Allow Auto Invoice: Select YES to automate invoice generation for the orders paid using OAB iPay method.
  • Payment from Applicable Countries: Select countries to allow using this payment method.
  • Sort Order: Enter Sort Order of the payment method display in the frontend.

 

 

  1. OAB iPay Method in Frontend
    Once the payment method is configured, the OAB iPay method is shown on the frontend while checking out the products. Just select the payment method, click “Place Order” to get redirected to the hosted payment page and complete the payment.

 

  • Redirection to the Gateway
    Once the customer gets redirected to the OAB iPay hosted payment page, he adds card details and clicks “Proceed” to finish the payment.

 

  • OAB iPay Details in “My Account” section
    Once the order is placed, the OAB iPay details are shown in the Account dashboard, in the “My Orders” tab having payment method name, payment ID, transaction status, transaction ID, reference ID, and tracking ID.

 

 

  1. OAB iPay Details in Backend
    Apart from the customers, admin can also see the payment details for the orders in the backend. Go to Sales à Orders and you can see OAB iPay details under a particular order. Also, the order view has a button named “OAB Inquiry” for the admin to know the status of the order payment before generating shipment.