Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages
Vend::Payment::BoA(3) User Contributed Perl Documentation Vend::Payment::BoA(3)

Vend::Payment::BoA - Interchange Bank of America Support

    [charge mode=boa param1=value1 param2=value2]

  LWP::UserAgent and Crypt::SSLeay
Only one of these need be present and working.

The Vend::Payment::BoA module implements the boa() routine for use with Interchange. It is compatible on a call level with the other Interchange payment modules -- in theory (and even usually in practice) you could switch from CyberCash to BoA with a few configuration file changes.
To enable this module, place this directive in "interchange.cfg":
    Require module Vend::Payment::BoA
This must be in interchange.cfg or a file included from it.
Make sure CreditCardAuto is off (default in Interchange demos).
The mode can be named anything, but the "gateway" parameter must be set to "boa". To make it the default payment gateway for all credit card transactions in a specific catalog, you can set in "catalog.cfg":
    Variable   MV_PAYMENT_MODE  boa
It uses several of the standard settings from Interchange payment. Any time we speak of a setting, it is obtained either first from the tag/call options, then from an Interchange order Route named for the mode, then finally a default global payment variable, For example, the "id" parameter would be specified by:
    [charge mode=boa id=YourBoAID]
    Route boa id YourBoAID
    Variable MV_PAYMENT_ID      YourBoAID
The active settings are:
Your BoA merchant_id (ioc_merchant_id), supplied by BoA when you sign up. Global parameter is MV_PAYMENT_ID.
Type of transaction to execute. May be:
  authorize - Perform authorization only (default)
  sale      - Authorize and settle (requires two separate requests)
  settle    - Perform settlement only on previously authorized transaction
  return    - Make a refund on previously settled transaction
Global parameter is MV_PAYMENT_TRANSACTION
The url of the web page you are posting from, required by BoA Global parameter is MV_PAYMENT_REFERER
The return codes for which you consider a credit card acceptable, comma separated. Codes are:
  -1   "Faith" authorization. (See for details)
   0    Order authorized.
   1    Some other failure. Try again.
   2    Card Declined.  Do not accept the order.
   3    No response from issuing institution.  Try again.
   4    Bad card.  Do not accept the order. Merchant should call shopper
   5    Error in transfer amount.
   6    Credit card expired.
   7    Transaction is invalid.
   8    Unknown system error.
   9    Duplicate request.  This transaction was completed earlier.
   >=10 Other error.  Contact you merchant bank representative.
Default is to accept for return code <= 0. 'accept' codes only valid on authorize transaction. All others only successful with return code of 0.
Global parameter is MV_PAYMENT_ACCEPT
        Ex: Variable MV_PAYMENT_ACCEPT -1,0,1,3,8,10
The error displayed if Bank of America is not responding, or is down. Default is "Credit card processor not responding. Please try again later or call our customer service directly".
Global parameter is MV_PAYMENT_TIMEOUT_ERROR
userid used to log in to Back Office (not needed for authorization only)
Global parameter is MV_PAYMENT_USERNAME
password used to log in to Back Office (not needed for authorization only)
Global parameter is MV_PAYMENT_SECRET

Try the instructions above, then enable test mode in the online account manager. A test order should complete.
Disable test mode, then test in various BoA error modes by using the credit card number 4222 2222 2222 2222.
Then try a sale with the card number "4111 1111 1111 1111" and a valid expiration date. The sale should be denied, and the reason should be in [data session payment_error].
If nothing works:
Make sure you "Require"d the module in interchange.cfg:
    Require module Vend::Payment::BoA
Make sure either Net::SSLeay or Crypt::SSLeay and LWP::UserAgent are installed and working. You can test to see whether your Perl thinks they are:
    perl -MNet::SSLeay -e 'print "It works\n"'
    perl -MLWP::UserAgent -MCrypt::SSLeay -e 'print "It works\n"'
If either one prints "It works." and returns to the prompt you should be OK (presuming they are in working order otherwise).
Check the error logs, both catalog and global.
Make sure you set your payment parameters properly.
Try an order, then put this code in a page:
        my $string = $Tag->uneval( { ref => $Session->{payment_result} });
        $string =~ s/{/{\n/;
        $string =~ s/,/,\n/g;
        return $string;
That should show what happened.
If all else fails, consultants are available to help with integration for a fee. See

There is actually nothing *in* Vend::Payment::BoA. It changes packages to Vend::Payment and places things there.

Mark Johnson, based on original code by Mike Heins.

    Jeff Nappi <>
    Paul Delys <>
    Ray Desjardins <>
    Nelson H. Ferrari <>

Hey! The above document had some coding errors, which are explained below:
Around line 165:
You forgot a '=back' before '=head2'
2010-03-25 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.