gateway

<!-- ICS: Sonny Cook, Linkpoint: keyfile => secret -->

</para>
<section>
<title>Gateway Configuration</title>
<para>The first step is to fulfil the prerequisites of the payment module
(listed in the individual module documentation below) and enable the module
in the global configuration file with the &conf-Require; directive:
<programlisting>
require Vend::Payment::NetBilling
</programlisting>
</para>
<para>
If we are using only one gateway in a catalog, setting up
<literal>MV_PAYMENT</literal> variables is sufficient.

<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>Variable</entry>
<entry>Purpose</entry>
<entry>Notes</entry>
</row>
</thead>
<tbody>
<row>
<entry>&var-MV_PAYMENT_MODE;</entry>
<entry>gateway mode name</entry>
<entry></entry>
</row>
<row>
<entry><literal>MV_PAYMENT_HOST</literal></entry>
<entry>gateway host name</entry>
<entry>optional (predefined in module)</entry>
</row>
<row>
<entry>&var-MV_PAYMENT_ID;</entry>
<entry>merchant identifier</entry>
<entry></entry>
</row>
<row>
<entry>&var-MV_PAYMENT_SECRET;</entry>
<entry>secret part of credentials</entry>
<entry>password or certificate</entry>
</row>
<row>
<entry><literal>MV_PAYMENT_REFERER</literal></entry>
<entry>referring URL</entry>
<entry></entry>
</row>
<row>
<entry><literal>MV_PAYMENT_TEST</literal></entry>
<entry>test mode</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>

An example configuration looks like:
<programlisting>
Variable MV_PAYMENT_MODE signio
Variable MV_PAYMENT_PARTNER verisign
Variable MV_PAYMENT_ID nevairbe
Variable MV_PAYMENT_SECRET foobar
</programlisting>
</para>
</section>

<section id="gateway_multiple">
<title>Multiple Gateways</title>
<para>
With the &conf-Route; directive it is possible to specify payment gateways
for special purposes. The payment route should set all relevant payment
parameters for the gateway, otherwise the settings from the MV_PAYMENT_* may
leak into the route.
<programlisting>
Route signio partner verisign
Route signio id nevairbe
Route signio secret foobar
</programlisting>
</para>
</section>

<section id="gateway_transaction_types">
<title>Transaction Types</title>
<para>
The following payment gateway transactions are known by Interchange:

<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Transaction</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>avs</entry>
<entry>Address verification (&glos-AVS;)</entry>
</row>
<row>
<entry>auth</entry>
<entry>Payment authorization (Charge)</entry>
</row>
<row>
<entry>return</entry>
<entry>Credit</entry>
</row>
<row>
<entry>reverse</entry>
<entry>Reverse former transaction</entry>
</row>
<row>
<entry>sale</entry>
<entry>Charge <emphasis>and</emphasis> capture</entry>
</row>
<row>
<entry>settle</entry>
<entry>Capture of an authorized charge</entry>
</row>
<row>
<entry>void</entry>
<entry>Cancel or refund payment</entry>
</row>
<row>
<entry>abort</entry>
<entry>Abort pending capture.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>

<section id="gateway_payment_modules">
<title>Payment Modules</title>
<para>
Modules for the following payment gateways are included in the Interchange source
code:

<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Module</entry>
<entry>Name</entry>
<entry>Mode</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>AuthorizeNet</literal></entry>
<entry>AuthorizeNet</entry>
<entry><literal>authorizenet</literal></entry>
</row>
<row>
<entry><literal>BoA</literal></entry>
<entry>Bank of America</entry>
<entry><literal>boa</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>BusinessOnlinePayment</literal></entry>
<entry>Business::OnlinePayment</entry>
<entry><literal>onlinepayment</literal></entry>
<entry>wrapper for <ulink url='http://search.cpan.org/perldoc?Business::OnlinePayment'>Business::OnlinePayment</ulink></entry>
</row>
<row>
<entry><literal>Cybercash</literal></entry>
<entry>Cybercash</entry>
<entry><literal>cybercash</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>ECHO</literal></entry>
<entry>Electronic Clearing House, Inc.</entry>
<entry><literal>echo</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>EFSNet</literal></entry>
<entry><ulink url='http://www.concordefsnet.com'>Concord
EFSNet</ulink></entry>
<entry><literal>echo</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>Ezic</literal></entry>
<entry>EziC</entry>
<entry><literal>ezic</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>Getitcard</literal></entry>
<entry><ulink url='http://www.getitcard.com'>Getitcard</ulink></entry>
<entry><literal>getitcard</literal></entry>
<entry>Prepaid cards from Getitcard.</entry>
</row>
<row>
<entry><literal>ICS</literal></entry>
<entry>Cybersource ICS</entry>
<entry><literal>ICS</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>iTransact</literal></entry>
<entry>iTransact</entry>
<entry><literal>itransact</literal></entry>
</row>
<row>
<entry><literal>Linkpoint</literal></entry>
<entry>LinkPoint</entry>
<entry><literal>linkpoint</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>MCVE</literal></entry>
<entry>Mainstreet Credit Verification Engine</entry>
<entry><literal>mcve</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>NetBilling</literal></entry>
<entry>NetBilling</entry>
<entry><literal>netbilling</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>PRI</literal></entry>
<entry>Payment Resources International</entry>
<entry><literal>PRI</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>PSiGate</literal></entry>
<entry>PSiGate</entry>
<entry><literal>psigate</literal></entry>
<entry></entry>
</row>
<row>
<entry><literal>Sage</literal></entry>
<entry><ulink url='http://www.sagepayments.com/'>Sage Payment</ulink></entry>
<entry><literal>sage</literal></entry>
</row>
<row>
<entry><literal>Signio</literal></entry>
<entry>Payflow Pro</entry>
<entry><literal>signio</literal></entry>
</row>
<row>
<entry><literal>Skipjack</literal></entry>
<entry>Skipjack</entry>
<entry><literal>skipjack</literal></entry>
</row>
<row>
<entry><literal>TCLink</literal></entry>
<entry>TrustCommerce</entry>
<entry><literal>trustcommerce</literal></entry>
</row>
<row>
<entry><literal>TestPayment</literal></entry>
<entry>Payment Test</entry>
<entry><literal>testpayment</literal></entry>
<entry>for test purposes</entry>
</row>

</tbody>
</tgroup>
</informaltable>
</para>
</section>

<section>
<title>AuthorizeNet</title>
<para>
The AuthorizeNet module implements the ADC Direct Response method for
AuthorizeNet version 3.
</para>
<section>
<title>Prerequisites</title>
<para>
Either Net::SSLeay or LWP::UserAgent and Crypt::SSLeay from CPAN.
</para>
</section>
<section>
<title>Parameters</title>
<para>Required parameters are id and secret.</para>
<section>
<title>id</title>
<para>
The AuthorizeNet account ID, received from AuthorizeNet after sign up.
</para>
</section>
<section>
<title>secret</title>
<para>
The AuthorizeNet account password, received from AuthorizeNet after sign up.
</para>
</section>
</section>
</section>

<section>
<title>ECHO</title>
<section>
<title>Prerequisites</title>
<para>
OpenECHO module from <ulink url='http://www.openecho.com/'>http://www.openecho.com/</ulink>.
</para>
</section>
</section>

<section>
<title>Getitcard</title>
<para>
The Getitcard payment module is used for purchases with prepaid cards issued
by Getitcard&reg;
(<ulink url='http://www.getitcard.com/'>http://www.getitcard.com/</ulink>).
</para>
<section>
<title>Prerequisites</title>
<para>
Either Net::SSLeay or LWP::UserAgent and Crypt::SSLeay from CPAN.
</para>
</section>
<section>
<title>Parameters</title>
<para>Required parameter is <literal>id</literal>.</para>
</section>
</section>

<section>
<title>LinkPoint</title>
<para>
</para>
<section><title>Parameters</title>
<para>Required parameters are <literal>id</literal> and <literal>keyfile</literal>.
</para>
<section><title><literal>host</literal></title>
<para>
The domain name of the LinkPoint Secure Payment Gateway (LSPG). Default is
<literal>secure.linkpt.net</literal> for production and
<literal>staging.linkpt.net</literal> for testing.
</para>
</section>
<section><title><literal>id</literal></title>
<para>
Store number assigned to your merchant account.
</para>
</section>
<section><title><literal>keyfile</literal></title>
<para>
File name of the merchant security certificate. This file should contain the
RSA private key and the certificate, otherwise you get an error like
"Unable to open/parse client certificate file."
</para>
</section>
<section><title><literal>transaction</literal></title>
<para>
The type of transaction to be run. Valid values are:
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row><entry>Interchange</entry><entry>Linkpoint</entry></row>
</thead>
<tbody>
<row><entry>auth</entry><entry>preauth</entry></row>
<row><entry>sale</entry><entry>sale</entry></row>
</tbody>
</tgroup>
</informaltable>
<para>
Default is <literal>sale</literal>.
</para>
</section>
</section>
</section>

<section>
<title>Netbilling</title>
<para>
The Netbilling module implements the <ulink
url="http://netbilling.com/direct/direct2.html">Netbilling Direct Mode
2.1</ulink>.
</para>
<section><title>Prerequisites</title>
</section>
<section><title>Parameters</title>
<section><title><literal>host</literal></title>
<para>
The domain name of the NetBilling secure server.  Defaults to
<literal>secure.netbilling.com</literal>.
</para>
</section>
<section><title><literal>id</literal></title>
<para>
This is your account and sitetag separated by a colon (ACCOUNT:SITETAG).
ACCOUNT is the number of your Netbilling merchant or agent account, as a
12-character string. Required for ALL transactions. SITETAG is the site
tag of your website configured in the Netbilling system. Required for
membership transactions, optional for others.
</para>
</section>
</section>
</section>

<section>
<title>Sage</title>
<section>
<title>Parameters</title>
<para>
Required parameters are <literal>id</literal> and <literal>secret</literal>.
</para>
</section>
</section>

<section>
<title>Signio</title>
<section>
<title>Parameters</title>
<para>
Required parameters are <literal>partner</literal>, <literal>id</literal>,
and <literal>secret</literal>.
</para>
</section>
</section>

<section>
<title>TCLink</title>
<section>
<title>Prerequisites</title>
<para>
Net::TCLink module from <ulink
url='http://www.trustcommerce.com/tclink.html'>http://www.trustcommerce.com/tclink.html</ulink>
or <ulink url='http://search.cpan.org/perldoc?Net::TCLink'>CPAN</ulink>.
</para>
</section>
</section>

<section>
<title>TestPayment</title>
<para>This module can be used for test purposes.</para>
<section>
<title>Card Numbers</title>
<para>
If the card number is <literal>4111111111111111</literal> then the
transaction will be approved.
</para>
<para>
If the card number is <literal>4111111111111129</literal> then the
transaction will be declined.
</para>
<para>
Any other card number will raise an error and the transaction will be declined.
</para>
</section>
</section>

<para>