Merchant Partners (PayMeNow)
osC Payment Module v1.67
Install Instructions & Documentation
by Lane Roathe of Ideas From the Deep
  Table of Contents

Description
Download & Support
Future Additions & Known Issues
Step by Step Installation Guide
Updating to a newer version
Configuration
What this contribution does
How to use this contribution
Frequently Asked Questions (FAQ)
Donate to help ongoing development
Version History

  Description

This contribution consists of two parts:

1. The admin section for configuring the payment modules

2. The checkout section for handling input of credit card/check information, sending that information securely for verification and handling the result of the verification.

For each section there is a file for credit cards and a file for electronic checks (echecks). PayMeNow doesn't charge an extra monthly fee for echecks, so giving your customers this option is easy. You do have to make sure to check on the status of echecks because they have to clear just like normal checks.


  Download and Support

Support can be found at: http://forums.oscommerce.com/index.php?showtopic=112633

Download From: http://www.oscommerce.com/community/contributions,2456

  Future Additions / Known Issues

- I'd like to add in more information about an order, ala the PayPal 3.x contribution. But, that's a lot of extra code to merge into many files so I'm reluctant to do so.

- I am using the Credit Card class contribution to show what credit cards are accepted (or, echeck is accepted). It's fairly easy, but I haven't figured out a good way to handle adding it to this contribution for the general public.

  Installation

Step 1:
!!! BACKUP !!!    !!! BACKUP !!!    !!! BACKUP !!!    !!! BACKUP !!!    !!! BACKUP !!!

Backup your files and database! You have been warned, and none of the authors take any responsibility for anything bad that happens by installing, using, or even looking at this contribution!


Step 2:
Copy all files in the provided directory "catalog" to your OSC directory following the same directory structure.

Note: All files provided are new and not core OSC files, and will not overwrite any files except if you are upgrading from a previous version of this Recover Cart Sales contribution.
Provided files:
  • /catalog/cvv.html
  • /catalog/images/checksample.gif
  • /catalog/images/cv_amex_card.gif
  • /catalog/images/cv_card.gif
  • /catalog/images/symbol_account.gif
  • /catalog/images/symbol_route.gif
  • /catalog/includes/languages/english/modules/payments/ccmerchantpartners.php
  • /catalog/includes/languages/english/modules/payments/ckmerchantpartners.php
  • /catalog/includes/modules/payment/ccmerchantpartners.php
  • /catalog/includes/modules/payment/ckmerchantpartners.php
    • (I only have know English sot that's all that's provided. If you'd like to provide a translation please send it to me and I'll update the contribution.)


    Step 3:
    After the files have been copied, you should have two new options under the "Payment" section of the Modules admin area for the cart:
  • Credit Card (Merchant Partners)
  • Electronic Check (Merchant Partners)
    • If you do not then Step 2 was not completed correctly, or the contribution is not compatible with your osC installation (but should be easy to update)


    Step 4:
    Modify your language file(s) to reflect what credit cards you accept:
  • /catalog/includes/languages/modules/payment/ccmerchantpartners.php
    • Change this line:


    To display which credit cards you accept.


    Step 5:
    Go to the Payment section of the Modules area in your admin and select Credit Card (Merchant Partners) and configure for use:
     
    Parameter Name Value Explanation
    Enable merchantPartners Module True True if enabled (ie, customers can use module to make payments), false if not.
    AcctID account id The account ID provided by PayMeNow, which is usually 5 characters long
    SubID blank Typically blank, unless you need sub-id's and you have set them up already on the PayMeNow wesite.
    Merchant PIN blank A secret Key/PIN to validate the transaction source.
    Enable PreAuth False If true then orders are only pre-authorized and you have to manually post transactions. False, the default, gives you instant purchases.
    Payment Zone blank If you only accept this type of payment in a zone (ie, some part of the world) then set that zone here.
    Set Order Status default Set this to the order status that this module sets when an order is completed. "default" says to use the default completion status value as configured in the status area.
    Sort order of display 10 Determines the order this payment module is displayed. Modules are displayed from lowest sort order value to highest, so you need to look at the other payment module's sort order values to determine which value to use here.


    Step 6:
    Go to the Payment section of the Modules area in your admin and select Checks (Merchant Partners) and configure for use:
     
    Parameter Name Value Explanation
    Enable merchantPartners Check Module True True if enabled (ie, customers can use module to make payments), false if not.
    AcctID account id The account ID provided by PayMeNow, which is usually 5 characters long
    SubID blank Typically blank, unless you need sub-id's and you have set them up already on the PayMeNow wesite.
    Merchant PIN blank A secret Key/PIN to validate the transaction source.
    Enable Standard ACH or Extended ACH ACH Default is Standard ACH. Must be setup to accept Extended ACH.
    Payment Zone blank If you only accept this type of payment in a zone (ie, some part of the world) then set that zone here.
    Set Order Status default Set this to the order status that this module sets when an order is completed. "default" says to use the default completion status value as configured in the status area.
    Sort order of display 10 Determines the order this payment module is displayed. Modules are displayed from lowest sort order value to highest, so you need to look at the other payment module's sort order values to determine which value to use here.

    Step 7:
    Test with a live credit card! (And echeck if you have that module enabled). Often times there are problems with your merchant account setup or the settings you entered into the module's configuration that can only be found with a live purchase.

    Once you have completed your testing, log into your PayMeNow account (on the PayMeNow website) and void all of your test transactions. By voiding the transactions they never even appear on the CC statement (ie, it's as if they never happened). This, of course, only works before the transaction has posted, after that you have to issue a refund.
      Updating to a newer version

    If you are updating to a new version, then you should only have to copy the files over your existing ones. If you have made modifications to the installation on your system then use a file comparison program to locate the differences.

      What this contribution does

    Very simply, this contribution is a payment module for osCommerce v2.2 and allows you to accept customer payments in the form of credit cards and/or electronic checks. This does require you setup a merchant account and a PayMeNow account (PayMeNow can typically handle both for you).

    You can find out more about PayMeNow at:

    You can follow-up with discussion in the OSC forums at:

      How to Use this contribution

    Use of this module is very simple and there is really nothing to explain after the installation procedure. Once installed and configured (including enabling the payment modules) customers can order from your site and pay by credit card and/or electronic check. Of course, if you want to only accept Credit Cards or EChecks then you would simply only enable the payment method you wish to accept in the Payment section of the Modules admin area.

    And, once again, you can follow-up with discussion in the OSC forums at:

      Frequently Asked Questions (FAQ)

    Q: Why do these payment options not appear during customer checkout?

    A: The most likely answer is that you have not configured and/or enabled the module(s) in the Payment section of the Modules admin area. However, it could also be that you have selected a Zone for the module(s) and during checkout the customer's address is not within the zone specified for the module(s).
      Donate

    I, Lane Roathe, have sorta taken responsibility for maintaining this contribution and continue to try and improve and support it. I invest a lot of time and hard work into my contributions and updates. If you find this contribution or update of any use and feel that it is a great addition to your web store, please consider making a small donation. Any donations would greatly be appreciated and give me the incentive to continue!
      History


    v1.67 Mar 15, 2010 - Tony (www.merchantpartners.com)
  • Updated to Support Extended ACH. additional bug fixes.


    • v1.65 Feb 14, 2007 - Tony (www.merchantpartners.com)
  • Updated to use cURL and MerchantPIN


    • v1.61 Oct 16, 2007 - Tony (www.merchantpartners.com)
  • Modified the billing info

    • v1.56 Sept 9, 2005 - Tony (www.merchantpartners.com)
  • Modified the shipping info

    • v1.55 Jun 15, 2005 - Lane Roathe (www.ifd.com)
  • Instructions rewritten to be easier to read and follow
  • Merged Andrew's bug fix into the official code base

    • v1.52 Dec 19, 2004 - Andrew Jamison
  • Fixed bug for redirect (didn't pass url parameters)

    • v1.50 Sep 19, 2004 - Lane Roathe (www.ifd.com)
  • Updated to work with OSC 2.2
  • bug fixes to manner in which URLs were created (caused bad use of ? and &)
  • customer experience improvements
  • Added CVV explanation (new window, with text and graphic explanation)
  • Added Checking information help graphics (delineators, example check)
  • some real docs (hopefully somewhat clear :)

    • v1.47 Feb 14, 2003 - OSC 2.1 release
  • old version in osC contributions area

    • v1.40 Nov 1, 2002 - Initial Release
  • pre OSC 2 from PayMeNow website
    •