Installing Sage Exchange Desktop

Related topics

Before you can configure the integrated application to use Sage Exchange Desktop, you must complete the boarding process, where Sage Payment Solutions assigns you a merchant account (merchant ID and merchant key). Contact a Sage Payment Solutions Sales Representative at 800-652-2370 to obtain your merchant credentials.

Note: If you are a developer working on a Sage Payment Solutions integration, send an e-mail message to [email protected] for assistance.

Understanding merchant accounts

Sage Payment Solutions offers two types of accounts for merchants; Vault-only and Processing. A Vault-only account allows you to store credit card information in the Sage Payment Solutions Vault via Sage Exchange Desktop but does not allow you to process credit card transactions such as sales and refunds. A Processing account allows you to store credit card information in the Vault and to process transactions.

If you are a developer, you do not need a merchant account to integrate with Sage Payment Solutions.

Note: If you have a Vault-only account and want to upgrade to a Processing account, contact an Account Executive at 800-261-0240 ext. 410800 or [email protected].

Installing Sage Exchange Desktop

You can install Sage Exchange Desktop directly from the Sage Exchange Desktop Installation web page or download and save it to install from a network file share, local hard drive, or storage media such as a CD-ROM. The installation consists of two parts; a COM component that contains the SDK (MSI installation package) and the Desktop application. The COM component is a one time installation applicable to all users that does not require updating; however does require administrator rights to install. The Desktop application is installed per-user; therefore, each user who needs to process credit card transactions must install it (administrator rights are not required).

Additional installation information

Consider the following items for alternate installation methods or if you are integrating your software application with Sage Exchange Desktop:

  • Zip file download. Download the zipped file at https://www.sageexchange.com/install/baresetup.zip.This option is useful if the user is offline during the installation or to include the Sage Exchange Desktop installation in software distribution. Extract the contents (preserving the paths) to a temporary folder then install the SDK by running the MSI at [Temp folder]\sage payment module sdk\setup.msi then install Sage Exchange Desktop by running [Temp folder]\setup.exe.
  • MSI silent installation command. Use: msiexec.exe /i "path and filename of MSI" /qn.
  • Registry entries. The following registry entries are related the COM classes/interfaces supported by the SDK. Integrators can code them into their application to detect a valid MSI SDK installation. If these keys are not detected in the registry, it is an indication that the installation of the MSI SDK has failed.
  • [LOCAL MACHINE]\Software\Classes\CLSID\{41A449A9‐EFA9‐45E5‐A6BD‐9896A8194CD0}
  • [LOCAL MACHINE]\Software\Classes\CLSID\{89BB4535‐5A89‐43A0‐89C5‐19A4697E5C5C}
  • [LOCAL MACHINE]\Software\Classes\SpsModuleSkdCL.ModuleClient
  • [LOCAL MACHINE]\Software\Classes\SpsModuleSkdCL.ModuleResponse

Verifying the Sage Exchange Desktop installation

After installation, verify that the Sage Exchange Desktop icon (SE) runs as a service in the Microsoft Windows System Tray. The SE icon must display in the System Tray to use Sage Exchange Desktop for credit card processing.

Installing payment device drivers (optional)

The Sage Exchange Desktop Installation web page provides links to download software drivers for the Ingenico 3070 Card Reader, Ingenico iPP320 Card Reader, RDM EC Series Check Scanner, and the Moneris iPP320. After installing Sage Exchange Desktop, follow the steps below if you need to install software drivers for any of these devices.

Note: Go to https://support.sagepayments.com/FileManagement/Download/c06aa3c82f914bff873d09e3939afabd to download then review the Sage Payment Solutions Ingenico iPP320 Setup Guide before installing your Ingenico iPP320.

  1. Go to https://www.sageexchange.com/install/frminstall.aspx to reopen the Sage Exchange Desktop Installation web page. Find your device below then follow the driver installation steps:

    • Ingenico i3070 Card Reader. Click the link for your operating system to download the corresponding USB driver:
    • Ingenico iPP320 Card Reader. Click the link for your operating system to download the corresponding USB driver and CPX Server:
      • Microsoft Windows XP/Vista/Windows 7. Go to https://www.sageexchange.com/install/ipp320.zip to download the zip file. After downloading, extract the files into a temporary folder. Locate and then open the 0074‐07876‐0400, Telium USB Driver v7.0.0.3 for Win XP_VISTA_7_2008 folder then double-click UsbDrvInstall.exe to install the USB driver. After the installation is complete, locate and then open the CPX Server folder then double-click setup.exe to install CPX Server.
      • Microsoft Windows 8. Go to https://www.sageexchange.com/install/ipp320setup_windows8.zip to download the zip file. After downloading, extract the files into a temporary folder. Locate and then open the 0074‐08131‐0230, Telium USB Jungo Driver for Windows folder then double-click IngenicoUSBDrivers_2.30_setup.exe to install the USB driver. After the installation is complete, locate and then open the CPX Server folder then double-click setup.exe to install CPX Server.
    • RDM EC Series Check Scanner. Go to https://www.sageexchange.com/install/rdm.zip to download the zip file. After downloading, extract the zip file then double-click RDM_ADK_INST.exe to install the driver.
    • Equinox L5300 Card Reader. Go to https://www.sageexchange.com/install/equinox5300.zip to download the zip file. After downloading, extract the zip file then locate the appropriate folder for your operating system and then double-click the executable file to install the driver.
    • Moneris iPP320. Go to https://www.sageexchange.com/install/MonerisIPP320.zip to download the zip file. After downloading, extract the zip file and then open the folder IPP320driver-All version of Windows folder. Double-click IngenicoUSBDrivers_2.30_setup.exe to install the USB driver.