README.txt

1. Instructions
2. Description of fields
3. Support policy
4. License

-------------------------------------------------------------------------------
1. Instructions
-------------------------------------------------------------------------------

Please view readme_example.html for additional instructions.

-------------------------------------------------------------------------------
2. Description of fields
-------------------------------------------------------------------------------

// The description of these fields can be found at https://wwws.echo-inc.com/ISPGuide-Interface.asp
// Field requirements: https://wwws.echo-inc.com/ISPGuide-Fields2.asp

ECHOnline Field Name	  PHP methods to set field
---------------------     --------------------------------
	
order_type                set_order_type($value)    
transaction_type          set_transaction_type($value)
merchant_echo_id          set_merchant_echo_id($value)
merchant_pin              set_merchant_pin($value)
isp_echo_id               set_isp_echo_id($value)
isp_pin                   set_isp_pin($value)
authorization             set_authorization($value)
billing_ip_address        set_billing_ip_address($value)  
billing_prefix            set_billing_prefix($value)
billing_name              set_billing_name($value)
billing_first_name        set_billing_first_name($value)
billing_last_name         set_billing_last_name($value)
billing_company_name      set_billing_company_name($value)
billing_address1          set_billing_address1($value)
billing_address2          set_billing_address2($value)
billing_city              set_billing_city($value)
billing_state             set_billing_state($value)
billing_zip               set_billing_zip($value)
billing_country           set_billing_country($value)
billing_phone             set_billing_phone($value)
billing_fax               set_billing_fax($value)
billing_email             set_billing_email($value)
cc_number                 set_cc_number($value)
ccexp_month               set_ccexp_month($value)
ccexp_year                set_ccexp_year($value)
cnp_security              set_cnp_security($value)
counter                   set_counter($value)
debug                     set_debug($value)
ec_account                set_ec_account($value)
ec_account_type           set_ec_account_type($value)
ec_payment_type           set_ec_payment_type($value)
ec_address1               set_ec_address1($value)
ec_address2               set_ec_address2($value)
ec_bank_name              set_ec_bank_name($value)
ec_city                   set_ec_city($value)
ec_email                  set_ec_email($value)
ec_first_name             set_ec_first_name($value)
ec_id_country             set_ec_id_country($value)
ec_id_exp_mm              set_ec_id_exp_mm($value)
ec_id_exp_dd              set_ec_id_exp_dd($value)
ec_id_exp_yy              set_ec_id_exp_yy($value)
ec_id_number              set_ec_id_number($value)
ec_id_state               set_ec_id_state($value)
ec_id_type                set_ec_id_type($value)
ec_last_name              set_ec_last_name($value)
ec_other_name             set_ec_other_name($value)
ec_payee                  set_ec_payee($value)
ec_rt                     set_ec_rt($value)
ec_serial_number          set_ec_serial_number($value)
ec_state                  set_ec_state($value)
ec_transaction_dt         set_ec_transaction_dt($value)
ec_zip                    set_ec_zip($value)
grand_total               set_grand_total($value)
merchant_email            set_merchant_email($value) 
merchant_trace_nbr        set_merchant_trace_nbr($value)
original_amount           set_original_amount($value)
original_trandate_mm      set_original_trandate_mm($value)
original_trandate_dd      set_original_trandate_dd($value)
original_trandate_yyyy    set_original_trandate_yyyy($value)
original_reference        set_original_reference($value)
order_number              set_order_number($value)
product_description       set_product_description($value)
purchase_order_number     set_purchase_order_number($value)
sales_tax                 set_sales_tax($value)
track1                    set_track1($value)
track2                    set_track2($value) 
cnp_recurring             set_cnp_recurring($value) 


PHP methods
--------------------

Submit              // Used to send the transaction. If this is true, your order was successful


Returned fields from Submit
---------------------------
	
Note: The response returned is 3 XML fields: <ECHOTYPE1>,<ECHOTYPE2>,<ECHOTYPE3>.
<ECHOTYPE2> has HTML in it, and <ECHOTYPE3> has more XML tags.
The PHP class extracts all the XML fields returned from the response except <term_code>.
See XML fields below.  Go to ECHO's online specs to read about these XML fields returned:
https://wwws.echo-inc.com/ISPGuide-Interface.asp

// These variables are used after a transaction has been submitted.	
// You always get back all 3 responses

EchoResponse        // Show All 3 ECHOTYPE responses
echotype1           // Get <ECHOTYPE1> response
echotype2           // Get <ECHOTYPE2> response - HTML format (displayed in browser)
echotype3           // Get <ECHOTYPE3> response - XML format
		
// ECHOTYPE3 results
authorization       // Get <auth_code>
avs_result          // Get <avs_result>
decline_code        // Get <decline_code>
reference           // Get <echo_reference>
mac                 // Get <mac>
merchant_name       // Get <merchant_name>
merchant_trace_nbr  // Get <merchant_trace_nbr>
order_number        // Get <order_number>
security_result     // Get <security_result>
status              // Get <status>
grand_total         // Get <tran_amount>
tran_date           // Get <tran_date>  
version             // Get <version>

-------------------------------------------------------------------------------
3. Support policy
-------------------------------------------------------------------------------

The software on Openecho.com, ECHOpay.com and ECHOcart.com is designed 
for developers and programmers to use in programming payment processing on 
Web sites or through the Internet.  It is designed to operate with the ECHOnline 
payment gateway.  

All OpenECHO software has been tested and proven operational, and other users 
have successfully set it up on their platforms.  However, this cannot be guaranteed 
for every platform, and we do not warrant that it will work on any other system.  It is 
offered as is and with no warranty.  

Although all the software has been tested, we make no representations as to how 
or whether it can or cannot be utilized with a merchant's specific front-end software 
(shopping cart, payment form, etc.).  It is our policy that the responsibility for setting 
up the software lies with the merchant and/or the merchant's programmer to 
assure the functionality of the software in payment processing for any given Web 
site. 

The potential for problems in creating and/or implementing software are extensive, 
usually requiring the assistance of expert programmers to resolve. There are many 
possible conflicts between shopping cart software, web hosting servers, remote 
and/or virtual servers, and various server programs utilized by hosting companies, 
etc.   It is not ECHO's policy to offer application debugging, or code-level 
programming support.   It is our policy that such programming challenges are the 
responsibility of the merchant and/or the merchant's programmer.   

Questions

Questions can be sent to ECHO for general assistance via our developer support e-
mail as found at developer-support@echo-inc.com.  Our staff will assist with your 
questions, providing answers when they can.  In cases where we have an 
understanding of your PC or Web site environment and the issues involved, we 
provide specific answers and solutions.  In other cases, we can help identify the part 
of the process where the problem resides, but we may not necessarily know the 
exact remedy.  In other cases, we may not have the knowledge to troubleshoot 
problems with problems residing outside the ECHO environment.

OpenECHO developer forum:  http://www.openecho.com/forum/

-------------------------------------------------------------------------------
4. License
-------------------------------------------------------------------------------

In case of any license issues related to OpenECHO
please contact developer-support@echo-inc.com

OpenECHO License

* Copyright (c) 2002-2003 The OpenECHO Project.  All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:

* I. Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
	  
* II. Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the
  distribution.

* III. All advertising materials mentioning features or use of this
  software must display the following acknowledgment:
  "This product includes software developed by the OpenECHO Project.
  (http://www.openecho.com)"

* IV. The names "OpenECHO" must not be used to endorse or promote products
  derived from this software without prior written permission. For
  written permission, please contact developer-support@echo-inc.com

* V. Products derived from this software may not be called "OpenECHO"
  nor may "OpenECHO" appear in their names without prior written
  permission of the OpenECHO Project.

* VI. Redistributions of any form whatsoever must retain the following
  acknowledgment:
  "This product includes software developed by the OpenECHO Project
  (http://www.openecho.com)"

* THIS SOFTWARE IS PROVIDED BY THE OpenECHO PROJECT ``AS IS'' AND ANY
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenECHO PROJECT OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.