API Reference

Prerequisites

  • Upayments account
  • Magento 2.4.x

Installation

Install using FTP method

  1. Download the latest release of the plugin from our GitHub repository.
  2. Upload the content of the folder to magento2 installation directory: app/code/
  3. Run the following Magento commands:
    1. php bin/magento module:enable Mageserv_UPayments
    2. php bin/magento setup:upgrade
    3. php bin/magento setup:static-content:deploy
    4. php bin/magento cache:clean

Activating the Plugin

By default and after installing the module, it will be activated. To Disable/Enable the module:

Enable : php bin/magento module:enable Mageserv_UPayments

Disable: php bin/magento module:disable Mageserv_UPayments

Configure the Plugin

  1. Navigate to "Magento admin panel" >> Stores >> Configuration
  2. Open "Sales >> Payment Methods"
  3. Enable the Payment Gateway
  4. Enter the primary credentials
    • Enable Live Mode: Set to Yes after finish sandbox testing
    • Token: Enter your API key
    • Enable Debugging: If set to "Yes", it will log all Upayments requests and save it to the log file. Please disable it after finishing your debug to save your disk space
  5. Click Save Config