Skip to content

ActiveMerchant migration

The ActiveMerchant Migration feature allows a Business Admin user to import merchants and acquirers from GPayments ActiveMerchant (3DS1 MPI) to assist with the transition from 3DS1 to 3DS2. It can be accessed from the Administration interface > Settings > ActiveMerchant Migration tab.

am_migration

Supported ActiveMerchant versions

ActiveMerchant v5.1.12 or above is supported.

Migrate Merchants

All merchants will be assigned an Import status which shows if the merchant can be imported or not. They will also have a Status to indicate if they were Enabled or Disabled in the ActiveMerchant database. Both of these options can be used to filter the search results.

Import status

Import status can be one of the following values:

  • Already imported - The merchant is already imported. Merchant name and Merchant ID pair already exist in the system. A merchant with this status will have a disabled checkbox.
  • Unavailable - The merchant cannot be imported automatically and needs to be imported manually, see the manual import section. A merchant with this status will have a disabled checkbox.
  • Warning - The merchant is missing a Country and/or Default Currency value and can be imported with default values. Default values can be assigned in the popup dialog when initialising the import. The Country and/or Default Currency value will be overwritten for this merchant during the import process.
  • Available - The merchant can be imported automatically with its normal values.

Import merchants manually

When you click on a merchant row you can import the merchant manually by assigning the missing or incorrect fields, or edit any other fields. For merchants with an Unavailable status, this is the only option for importing.

Migrate Acquirers

All acquirers are assigned an Import status which shows if the acquirer can be imported or not.

Import status

Import status can be one of the following values:

  • Already imported - The acquirer is already imported. Acquirer name already exists in the system. Acquirers with this status will have a disabled checkbox.
  • Available - The acquirer can be imported automatically with its normal values.

Step-by-step migration

The migration process of merchants and acquirers is very similar. The following steps outline the migration process for merchants.

  1. Make sure you have configured the application-prod.properties file with your ActiveMerchant database details:

    1
    2
    3
    4
    as.migration.db.vendor=<ActiveMerchant database vendor> e.g. mysql, oracle, mssql, db2 or postgres
    as.migration.db.url=<ActiveMerchant database JDBC url> e.g. jdbc:mysql://<Your My SQL DB Host>:3306/<Your DB Name>
    as.migration.db.username=<ActiveMerchant database username>
    as.migration.db.password=<ActiveMerchant database password>
    
  2. If changes were made to the application-prod.properties file, restart your ActiveServer instance.

  3. Go to the Administration interface > Settings > ActiveMerchant Migration tab and select Connect to establish a connection between ActiveServer and the ActiveMerchant database. If connection is unable to be made an error will be shown.

  4. Check the checkbox of the merchants/acquirers you would like to import. Check the checkbox in the table header if you want to import all merchants, this will select all entries in the table.

    Unavailable merchants

    Any merchants that have an import status of Unavailable cannot be imported automatically as one of the required fields is either missing or not valid. To import these merchants see the manual import section.

  5. Select the import button which will popup a dialog similar to below:

    am_migration

    If you have selected merchants with a Warning import status, the dialog will ask you to pick default values to be used for importing. This feature is useful if you have several merchants with missing fields and requires the same default currency or country.

  6. Select the Import button to start the import process. Wait until the process is finished and the confirmation dialogue is shown before leaving the page. However, if the process is interrupted, all merchants already imported will be saved and have a Import Status of Already imported the next time import is run again.

FAQ

Should ActiveMerchant be running?

During migration, ActiveMerchant does not need to be running, simply make sure that ActiveServer can access the ActiveMerchant database.

Does migration affect my ActiveMerchant database?

No, the migration process will only read from the ActiveMerchant database you have configured and will not alter the current ActiveMerchant installation.

Do all the merchants or acquirers need to be imported in one session?

No, the migration process can be done multiple times. Each time ActiveServer connects to the ActiveMerchant database it will automatically set the Import Status to Already imported if existing merchant or acquirer information is detected.