Configuration

There are a few steps which must be taken to configure the module in the Zen Cart admin and to set up your PayOffline account correctly to work with this module...

1. SOAP technology support.

   Once you have installed the module it checks your PHP setup to see if a supported SOAP technology exists. If not, you will see quite a stark warning in the admin as the module cannot be used without a supported SOAP technology!

   Currently the module supports both PHP's inbuilt SOAP extension and the PEAR repository SOAP package.

   1. To use PHP5's SOAP extension you must enable the extension in your PHP installation. Information about enabling this extension can be found at http://www.php.net/manual/en/ref.soap.php.

      Basically, for a PHP installation compiled from source, enabling PHP5's SOAP extension involves:

      • Configuring PHP with --enable-source

      For a PHP installation installed as a windows binary, enabling PHP5's SOAP extension involves:

      • Uncommenting the following line in php.ini:

        extension=php_soap.dll

   2. To install the PEAR:SOAP package you must:

      • “SSH” into your server and run the following command:

        pear install SOAP

        If you don't understand what these particular instructions mean, ask your web host to do it for you, it's not much effort for them.

      Please Note: If you keep getting errors about not having a supported SOAP technology installed despite having successfully installed the PEAR SOAP package then please consult the FAQs for possible solutions.

2. Add some Order Statuses to your store.

   There are certain actions which can be carried out by PayOffline when particular situations occur. These include:

   • A customer paying some or all of their outstanding bill at a PayZone store.
   • The allowed payment period expiring without the customer having paid their bill at a PayZone store.

   Whenever one of these situations occurs, PayOffline sends a “callback” to the payoffline_ipro module which can be used to update an order's status. As such, appropriate order statuses should be set up as necessary.

   • Go to Localization > Order Status. Make sure that there are order statuses to cover the following circumstances:

     • Awaiting Payment
     • Paid
     • Underpaid
     • Overpaid
     • Payment Period Expired

3. Configure your PayOffline Accounts.

   All PayOffline merchants should have two accounts set up, a Test account and a Live account. It is highly recommended that you use the Test Transaction Server at first, to check that everything is working as expected, before switching to using the Live Transaction Server.

   • Log into the PayOffline Test Centre and go to the Test Settings page. Set the following values:

     • MD5 Signature - Tick “Always use MD5 signatures”.
     • Leave the Call back URL blank.
     • Tick all callback options that can be ticked.
     • Save the settings using Save Merchant Settings.

   • Log into the PayOffline Administration Centre and go to the Transaction Settings page. Set the following values:

     • MD5 Signature - Tick “Always use MD5 signatures”.
     • Leave the Call back URL blank.
     • Tick all 4 of the callback options.
     • Set “Send Notification Message” to an appropriate value (this triggers PayOffline's reminder E-mail to the customer).
     • Set “Expiry Days” to an appropriate value.
     • Save the settings using Save Settings.

4. Configure the module.

   It is highly recommended that you use the Test Transaction Server at first, to check that everything is working as expected, before switching to using the Live Transaction Server.

   Please Note: The Merchant ID and Secret Key are different for your test account and your live account! You should use the Merchant ID and Secret Key for your test account first, then the Merchant ID and Secret Key for your live account!

   You can get the Merchant ID and Secret Key for your Test account by logging into the PayOffline Test Centre and going to Test Settings.

   You can get the Merchant ID and Secret Key for your Live account by logging into the PayOffline Administration Centre and going to Transaction Settings.

   • Set the Merchant ID and Secret Key according to the Transaction Server to be used.

   • Configure the Order Status Settings with those set up previously.

   • Configure the E-mail Settings as appropriate.

   That's it! Once you've put through a few test transactions on the Test Transaction Server you can reconfigure the module with the Merchant ID and Secret Key for your Live account and start accepting payments from customers using PayOffline!

Back to top