OpenECHO.pm

   1 ##############################################################################\r
   2 # Business::OnlinePayment::OpenECHO\r
   3 #\r
   4 # Credit card transactions via SSL to\r
   5 # Electronic Clearing House (ECHO) Systems\r
   6 #\r
   7 # Refer to ECHO's documentation for more info\r
   8 # http://www.openecho.com/echo_gateway_guide.html\r
   9 #\r
  10 # AUTHOR\r
  11 # Michael Lehmkuhl <michael@electricpulp.com>\r
  12 #\r
  13 # SPECIAL THANKS\r
  14 # Jim Darden <jdarden@echo-inc.com>\r
  15 # Dan Browning <db@kavod.com>\r
  16 #\r
  17 # BUSINESS::ONLINEPAYMENT IMPLEMENTATION\r
  18 # Ivan Kohler <ivan-openecho@420.am>\r
  19 #\r
  20 # VERSION HISTORY\r
  21 # + v1.2        08/17/2002 Corrected problem with certain string comparisons.\r
  22 # + v1.3        08/23/2002 Converted Interchange GlobalSub to Vend::Payment module.\r
  23 # + v1.3.1      11/12/2002 Updated the OpenECHO_example.perl test script.\r
  24 # + v1.4        11/18/2002 Corrected a problem with Submit method when using LWP.\r
  25 # + v1.5        03/29/2003 Updated for additional status and avs_result codes.\r
  26 # + v1.6        08/26/2003 Cleaned up code (salim qadeer sqadeer@echo-inc.com)\r
  27 # + v1.6.2      09/23/2003 Added DH transaction type (salim qadeer sqadeer@echo-inc.com)\r
  28 # --------\r
  29 # + v0.1        08/26/2004 Business::OnlinePayment implementation\r
  30 #\r
  31 # Copyright (C) 2002 Electric Pulp. <info@electricpulp.com>\r
  32 # Copyright (C) 2004 Ivan Kohler\r
  33 #\r
  34 # This program is free software; you can redistribute it and/or modify\r
  35 # it under the terms of the GNU General Public License as published by\r
  36 # the Free Software Foundation; either version 2 of the License, or\r
  37 # (at your option) any later version.\r
  38 #\r
  39 # This program is distributed in the hope that it will be useful,\r
  40 # but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  41 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  42 # GNU General Public License for more details.\r
  43 #\r
  44 # You should have received a copy of the GNU General Public\r
  45 # License along with this program; if not, write to the Free\r
  46 # Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,\r
  47 # MA  02111-1307  USA.\r
  48 #\r
  49 ################################################################################\r
  50 \r
  51 package Business::OnlinePayment::OpenECHO;\r
  52 \r
  53 use strict;\r
  54 use Carp;\r
  55 use Business::OnlinePayment 3;\r
  56 use Business::OnlinePayment::HTTPS;\r
  57 use vars qw($VERSION @ISA);\r
  58 \r
  59 @ISA = qw(Business::OnlinePayment::HTTPS);\r
  60 $VERSION = '0.01';\r
  61 \r
  62 sub set_defaults {\r
  63         my $self = shift;\r
  64 \r
  65         $self->server('wwws.echo-inc.com');\r
  66         $self->port('443');\r
  67         $self->path('/scripts/INR200.EXE');\r
  68 \r
  69         $self->build_subs(qw(\r
  70           order_number avs_code\r
  71                          ));\r
  72         # order_type\r
  73         # md5 cvv2_response cavv_response\r
  74 \r
  75 }\r
  76 \r
  77 #map_fileds originally from AuthorizeNet.pm\r
  78 \r
  79 sub map_fields {\r
  80     my($self) = @_;\r
  81 \r
  82     ##AD (Address Verification)  - 0.18 cents\r
  83     #AS (Authorization) - 0.18 cents\r
  84     #AV (Authorization with Address Verification) - 0.18 cents\r
  85     #CR (Credit) - 0.18 cents + 0.12 cents (discount fee returned to merchant)\r
  86     #DS (Deposit) - 0.18 cents + 0.12 cents\r
  87     #ES (Authorization and Deposit) - 0.18 cents + 0.12 cents + an extra 0.17%\r
  88     #EV (Authorization and Deposit with Address Verification) - 0.18 cents + 0.12 cents\r
  89     ##CK (System check) - 0.18 cents\r
  90     #DV (Electronic Check Verification) - check your contract\r
  91     #DD (Electronic Check Debit with Verification) - check your contract\r
  92     #DH (Electronic Check Debit ACH Only) - check your contract\r
  93     #DC (Electronic Check Credit) - check your contract\r
  94 \r
  95     my %content = $self->content();\r
  96 \r
  97     my $avs = $self->require_avs;\r
  98     $avs = 1 unless defined($avs) && length($avs); #default AVS on unless explicitly turned off\r
  99 \r
 100     my %map;\r
 101     if (\r
 102       $content{'type'} =~ /^(cc|visa|mastercard|american express|discover)$/i\r
 103     ) {\r
 104       if ( $avs ) {\r
 105         %map = ( 'normal authorization' => 'EV',\r
 106                  'authorization only'   => 'AV',\r
 107                  'credit'               => 'CR',\r
 108                  'post authorization'   => 'DS',\r
 109                  #'void'                 => 'VOID',\r
 110                );\r
 111       } else {\r
 112         %map = ( 'normal authorization' => 'ES',\r
 113                  'authorization only'   => 'AS',\r
 114                  'credit'               => 'CR',\r
 115                  'post authorization'   => 'DS',\r
 116                  #'void'                 => 'VOID',\r
 117                );\r
 118       }\r
 119     } elsif ( $content{'type'} =~ /^check$/i ) {\r
 120       %map = ( 'normal authorization' => 'DD',\r
 121                'authorization only'   => 'DV',\r
 122                'credit'               => 'DC',\r
 123                'post authorization'   => 'DH',\r
 124                #'void'                 => 'VOID',\r
 125              );\r
 126     } else {\r
 127       croak 'Unknown type: '. $content{'type'};\r
 128     }\r
 129 \r
 130     $content{'type'} = $map{lc($content{'action'})}\r
 131       or croak 'Unknown action: '. $content{'action'};\r
 132 \r
 133     $self->transaction_type($content{'type'});\r
 134 \r
 135     # stuff it back into %content\r
 136     $self->content(%content);\r
 137 \r
 138 }\r
 139 \r
 140 sub submit {\r
 141     my($self) = @_;\r
 142 \r
 143     $self->map_fields();\r
 144     $self->remap_fields(\r
 145         #                => 'order_type',\r
 146         type             => 'transaction_type',\r
 147         #action          =>\r
 148         login            => 'merchant_echo_id',\r
 149         password         => 'merchant_pin',\r
 150         #                => 'isp_echo_id',\r
 151         #                => 'isp_pin',\r
 152         #transaction_key =>\r
 153         authorization    => 'authorization', # auth_code => 'authorization',\r
 154         customer_ip      => 'billing_ip_address',\r
 155         #                   'billing_prefix',\r
 156         name             => 'billing_name',\r
 157         first_name       => 'billing_first_name',\r
 158         last_name        => 'billing_last_name',\r
 159         company          => 'billing_company_name',\r
 160         address          => 'billing_address_1',\r
 161         #                => 'billing_address_2',\r
 162         city             => 'billing_city',\r
 163         state            => 'billing_state',\r
 164         zip              => 'billing_zip',\r
 165         country          => 'billing_country',\r
 166         phone            => 'billing_phone',\r
 167         fax              => 'billing_fax',\r
 168         email            => 'billing_email',\r
 169         card_number      => 'cc_number',\r
 170         #                => 'ccexp_month',\r
 171         #                => 'ccexp_year',\r
 172         #                => 'counter',\r
 173         #                => 'debug',\r
 174 \r
 175         #XXX#            => 'ec_*',\r
 176 \r
 177         'amount'         => 'grand_total',\r
 178         #                => 'merchant_email',\r
 179         #invoice_number  =>\r
 180         customer_id      => 'merchant_trace_nbr',\r
 181         #                => 'original_amount',\r
 182         #                => 'original_trandate_mm',\r
 183         #                => 'original_trandate_dd',\r
 184         #                => 'original_trandate_yyyy',\r
 185         #                => 'original_reference',\r
 186         order_number     => 'order_number',\r
 187         #                => 'shipping_flag',\r
 188 \r
 189         #description       =>\r
 190         #currency          =>\r
 191 \r
 192         #ship_last_name    =>\r
 193         #ship_first_name   =>\r
 194         #ship_company      =>\r
 195         #ship_address      =>\r
 196         #ship_city         =>\r
 197         #ship_state        =>\r
 198         #ship_zip          =>\r
 199         #ship_country      =>\r
 200 \r
 201         #expiration        =>\r
 202         cvv2              => 'cnp_security',\r
 203 \r
 204         #check_type        =>\r
 205         #account_name      => 'ec_last_name' & 'ec_first_name',\r
 206         account_number    => 'ec_account',\r
 207         #account_type      =>\r
 208         bank_name         => 'ec_bank_name',\r
 209         routing_code      => 'ec_rt',\r
 210         #customer_org      =>\r
 211         #customer_ssn      =>\r
 212         license_num       => 'ec_id_number',\r
 213         license_state     => 'ec_id_state',\r
 214         #license_dob       =>\r
 215 \r
 216         #recurring_billing => 'cnp_recurring',\r
 217     );\r
 218 \r
 219     #XXX hosted order_type?\r
 220     $self->{_content}{order_type} = 'S';\r
 221 \r
 222     #XXX counter field shouldn't be just a random integer (but it does need a\r
 223     #default this way i guess...\r
 224     $self->{_content}{counter} = int(rand(2**31));\r
 225 \r
 226     #ccexp_month & ccexp_year\r
 227     $self->{_content}{'expiration'} =~ /^(\d+)\D+\d*(\d{2})$/\r
 228       or croak "unparsable expiration ". $self->{_content}{expiration};\r
 229     my( $month, $year ) = ( $1, $2 );\r
 230     $month = '0'. $month if $month =~ /^\d$/;\r
 231     $self->{_content}{ccexp_month} = $month;\r
 232     $self->{_content}{ccexp_year} = $year;\r
 233 \r
 234     $self->{_content}{cnp_recurring} = 'Y'\r
 235       if exists($self->{_content}{recurring_billing})\r
 236       && $self->{_content}{recurring_billing} =~ /^y/i;\r
 237 \r
 238     #XXX echeck use customer_org and account_type to generate ec_account_type\r
 239 \r
 240     #XXX set required fields\r
 241     # https://wwws.echo-inc.com/ISPGuide-Fields2.asp\r
 242     $self->required_fields();\r
 243 \r
 244     my( $page, $response, %reply_headers) =\r
 245       $self->https_get( $self->get_fields( $self->fields ) );\r
 246 \r
 247     #XXX check $response and die if not 200?\r
 248 \r
 249     my $echotype1 = $self->GetEchoReturn($page, 1);\r
 250     my $echotype2 = $self->GetEchoReturn($page, 2);\r
 251     my $echotype3 = $self->GetEchoReturn($page, 3);\r
 252     my $openecho  = $self->GetEchoReturn($page, 'OPEN');\r
 253 \r
 254     #   server_response\r
 255     #   avs_code\r
 256     #   order_number\r
 257     #   is_success\r
 258     #   result_code\r
 259     #   authorization\r
 260     #md5 cvv2_response cavv_response ...?\r
 261 \r
 262     # Get all the metadata.\r
 263     $self->server_response($page);\r
 264     $self->authorization( $self->GetEchoProp($echotype3, 'auth_code') );\r
 265     $self->order_number(  $self->GetEchoProp($echotype3, 'order_number') );\r
 266 \r
 267     #XXX ???\r
 268     #$self->reference(     $this->GetEchoProp($echotype3, "echo_reference");\r
 269 \r
 270     $self->result_code(   $self->GetEchoProp($echotype3, 'status') );\r
 271     $self->avs_code(      $self->GetEchoProp($echotype3, 'avs_result') );\r
 272 \r
 273     #XXX ???\r
 274     #$self->security_result( $self->GetEchoProp($echotype3, 'security_result');\r
 275     #$self->mac( $self->GetEchoProp($echotype3, 'mac') );\r
 276     #$self->decline_code( $self->GetEchoProp($echotype3, 'decline_code') );\r
 277 \r
 278     if ($self->result_code =~ /^[GR]$/ ) { #success\r
 279 \r
 280       #XXX special case for AVS-only transactions we don't handle yet\r
 281       #if ($self->transaction_type eq "AD") {\r
 282       #  if ($self->avs_code =~ /^[XYDM]$/ ) {\r
 283       #    $self->is_success(1);\r
 284       #  } else {\r
 285       #    $self->is_success(0);\r
 286       #  }\r
 287       #} else { \r
 288         $self->is_success(1);\r
 289       #}\r
 290 \r
 291     } else {\r
 292       $self->is_success(0);\r
 293 \r
 294       my $decline_code = $self->GetEchoProp($echotype3, 'decline_code');\r
 295       my $error_message = $self->error($decline_code);\r
 296       if ( $decline_code =~ /^(00)?30$/ ) {\r
 297         $echotype2 =~ s/<br>/\n/ig;\r
 298         $echotype2 =~ s'</?(b|pre)>''ig;\r
 299         $error_message .= ": $echotype2";\r
 300       }\r
 301       $self->error_message( $error_message );\r
 302 \r
 303     }\r
 304 \r
 305     $self->is_success(0) if $page eq '';\r
 306 \r
 307 }\r
 308 \r
 309 \r
 310 sub fields {\r
 311         my $self = shift;\r
 312 \r
 313         my @fields = qw(\r
 314           order_type\r
 315           transaction_type\r
 316           merchant_echo_id\r
 317           merchant_pin\r
 318           isp_echo_id\r
 319           isp_pin\r
 320           authorization\r
 321           billing_ip_address\r
 322           billing_prefix\r
 323           billing_name\r
 324           billing_first_name\r
 325           billing_last_name\r
 326           billing_company_name\r
 327           billing_address1\r
 328           billing_address2\r
 329           billing_city\r
 330           billing_state\r
 331           billing_zip\r
 332           billing_country\r
 333           billing_phone\r
 334           billing_fax\r
 335           billing_email\r
 336           cc_number\r
 337           ccexp_month\r
 338           ccexp_year\r
 339           counter\r
 340           debug\r
 341         );\r
 342 \r
 343         if ($self->transaction_type =~ /^D[DCVH]$/) {\r
 344           push @fields, qw(\r
 345             ec_account\r
 346             ec_account_type\r
 347             ec_payment_type\r
 348             ec_address1\r
 349             ec_address2\r
 350             ec_bank_name\r
 351             ec_business_acct\r
 352             ec_city\r
 353             ec_email\r
 354             ec_first_name\r
 355             ec_id_country\r
 356             ec_id_exp_mm\r
 357             ec_id_exp_dd\r
 358             ec_id_exp_yy\r
 359             ec_id_number\r
 360             ec_id_state\r
 361             ec_id_type\r
 362             ec_last_name\r
 363             ec_merchant_ref\r
 364             ec_nbds_code\r
 365             ec_other_name\r
 366             ec_payee\r
 367             ec_rt\r
 368             ec_serial_number\r
 369             ec_state\r
 370             ec_transaction_dt\r
 371             ec_zip\r
 372           );\r
 373         }\r
 374 \r
 375         push @fields, qw(\r
 376           grand_total\r
 377           merchant_email\r
 378           merchant_trace_nbr\r
 379           original_amount\r
 380           original_trandate_mm\r
 381           original_trandate_dd\r
 382           original_trandate_yyyy\r
 383           original_reference\r
 384           order_number\r
 385           shipping_flag\r
 386           shipping_prefix\r
 387           shipping_name\r
 388           shipping_address1\r
 389           shipping_address2\r
 390           shipping_city\r
 391           shipping_state\r
 392           shipping_zip\r
 393           shipping_comments\r
 394           shipping_country\r
 395           shipping_phone\r
 396           shipping_fax\r
 397           shipper\r
 398           shipper_tracking_nbr\r
 399           track1\r
 400           track2\r
 401           cnp_security\r
 402           cnp_recurring\r
 403         );\r
 404 \r
 405         return @fields;\r
 406 }\r
 407 \r
 408 sub GetEchoProp {\r
 409         my( $self, $raw, $prop ) = @_;\r
 410         local $^W=0;\r
 411 \r
 412         my $data;\r
 413         ($data) = $raw =~ m"<$prop>(.*?)</$prop>"gsi;\r
 414         $data =~ s/<.*?>/ /gs;\r
 415         chomp $data;\r
 416         return $data;\r
 417 }\r
 418 \r
 419 # Get's a given Echo return type and strips all HTML style tags from it.\r
 420 # It also strips any new line characters from the returned string.\r
 421 #\r
 422 # This function based on Ben Reser's <breser@vecdev.com> Echo::Process\r
 423 # module.\r
 424 sub GetEchoReturn {\r
 425         my( $self, $page, $type ) = @_;\r
 426         local $^W=0;\r
 427 \r
 428         my $data;\r
 429         if ($type eq 'OPEN') {\r
 430                 ($data) = $page =~ m"<OPENECHO>(.*?)</OPENECHO>"gsi;\r
 431         }\r
 432         else {\r
 433                 ($data) = $page =~ m"<ECHOTYPE$type>(.*?)</ECHOTYPE$type>"gsi;\r
 434         }\r
 435 #       $data =~ s"<.*?>" "g;\r
 436 \r
 437         #unless (length($data)) {\r
 438         #  warn "$self $page $type";\r
 439         #}\r
 440 \r
 441         chomp $data;\r
 442         return $data;\r
 443 }\r
 444 \r
 445 use vars qw(%error);\r
 446 %error = (\r
 447   "01" => [ "Refer to card issuer", "The merchant must call the issuer before the transaction can be approved." ],\r
 448   "02" => [ "Refer to card issuer, special condition", "The merchant must call the issuer before the transaction can be approved." ],\r
 449   "03" => [ "Invalid merchant number", "The merchant ID is not valid." ],\r
 450   "04" => [ "Pick-up card. Capture for reward", "The card is listed on the Warning Bulletin.  Merchant may receive reward money by capturing the card." ],\r
 451   "05" => [ "Do not honor. The transaction was declined by the issuer without definition or reason", "The transaction was declined without explanation by the card issuer." ],\r
 452   "06" => [ "Error", "The card issuer returned an error without further explanation." ],\r
 453   "07" => [ "Pick-up card, special condition", "The card is listed on the Warning Bulletin.  Merchant may receive reward money by capturing the card." ],\r
 454   "08" => [ "Honor with identification", "Honor with identification." ],\r
 455   "09" => [ "Request in progress", "Request in progress." ],\r
 456   "10" => [ "Approved for partial amount", "Approved for partial amount." ],\r
 457   "11" => [ "Approved, VIP", "Approved, VIP program." ],\r
 458   "12" => [ "Invalid transaction", "The requested transaction is not supported or is not valid for the card number presented." ],\r
 459   "13" => [ "Invalid amount", "The amount exceeds the limits established by the issuer for this type of transaction." ],\r
 460   "14" => [ "Invalid card #", "The issuer indicates that this card is not valid." ],\r
 461   "15" => [ "No such issuer", "The card issuer number is not valid." ],\r
 462   "16" => [ "Approved, update track 3", "Approved, update track 3." ],\r
 463   "17" => [ "Customer cancellation", "Customer cancellation." ],\r
 464   "18" => [ "Customer dispute", "Customer dispute." ],\r
 465   "19" => [ "Re enter transaction", "Customer should resubmit transaction." ],\r
 466   "20" => [ "Invalid response", "Invalid response." ],\r
 467   "21" => [ "No action taken", "No action taken. The issuer declined with no other explanation." ],\r
 468   "22" => [ "Suspected malfunction", "Suspected malfunction." ],\r
 469   "23" => [ "Unacceptable transaction fee", "Unacceptable transaction fee." ],\r
 470   "24" => [ "File update not supported", "File update not supported." ],\r
 471   "25" => [ "Unable to locate record", "Unable to locate record." ],\r
 472   "26" => [ "Duplicate record", "Duplicate record." ],\r
 473   "27" => [ "File update edit error", "File update edit error." ],\r
 474   "28" => [ "File update file locked", "File update file locked." ],\r
 475   "30" => [ "Format error, call ECHO", "The host reported that the transaction was not formatted properly." ],\r
 476   "31" => [ "Bank not supported", "Bank not supported by switch." ],\r
 477   "32" => [ "Completed partially", "Completed partially." ],\r
 478   "33" => [ "Expired card, pick-up", "The card is expired.  Merchant may receive reward money by capturing the card." ],\r
 479   "34" => [ "Issuer suspects fraud, pick-up card", "The card issuer suspects fraud.  Merchant may receive reward money by capturing the card." ],\r
 480   "35" => [ "Contact acquirer, pick-up", "Contact card issuer.  Merchant may receive reward money by capturing the card." ],\r
 481   "36" => [ "Restricted card, pick-up", "The card is restricted by the issuer.  Merchant may receive reward money by capturing the card." ],\r
 482   "37" => [ "Call ECHO security, pick-up", "Contact ECHO security.  Merchant may receive reward money by capturing the card." ],\r
 483   "38" => [ "PIN tries exceeded, pick-up", "PIN attempts exceed issuer limits.  Merchant may receive reward money by capturing the card." ],\r
 484   "39" => [ "No credit account", "No credit account." ],\r
 485   "40" => [ "Function not supported", "Requested function not supported." ],\r
 486   "41" => [ "Lost Card, capture for reward", "The card has been reported lost." ],\r
 487   "42" => [ "No universal account", "No universal account." ],\r
 488   "43" => [ "Stolen Card, capture for reward", "The card has been reported stolen." ],\r
 489   "44" => [ "No investment account", "No investment account." ],\r
 490   "51" => [ "Not sufficient funds", "The credit limit for this account has been exceeded." ],\r
 491   "54" => [ "Expired card", "The card is expired." ],\r
 492   "55" => [ "Incorrect PIN", "The cardholder PIN is incorrect." ],\r
 493   "56" => [ "No card record", "No card record." ],\r
 494   "57" => [ "Transaction not permitted to cardholder", "The card is not allowed the type of transaction requested." ],\r
 495   "58" => [ "Transaction not permitted on terminal", "The Merchant is not allowed this type of transaction." ],\r
 496   "59" => [ "Suspected fraud", "Suspected fraud." ],\r
 497   "60" => [ "Contact ECHO", "Contact ECHO." ],\r
 498   "61" => [ "Exceeds withdrawal limit", "The amount exceeds the allowed daily maximum." ],\r
 499   "62" => [ "Restricted card", "The card has been restricted." ],\r
 500   "63" => [ "Security violation.", "The card has been restricted." ],\r
 501   "64" => [ "Original amount incorrect", "Original amount incorrect." ],\r
 502   "65" => [ "Exceeds withdrawal frequency", "The allowable number of daily transactions has been exceeded." ],\r
 503   "66" => [ "Call acquirer security, call ECHO", "Call acquirer security, call ECHO." ],\r
 504   "68" => [ "Response received too late", "Response received too late." ],\r
 505   "75" => [ "PIN tries exceeded", "The allowed number of PIN retries has been exceeded." ],\r
 506   "76" => [ "Invalid \"to\" account", "The debit account does not exist." ],\r
 507   "77" => [ "Invalid \"from\" account", "The credit account does not exist." ],\r
 508   "78" => [ "Invalid account specified (general)", "The associated card number account is invalid or does not exist." ],\r
 509   "79" => [ "Already reversed", "Already reversed." ],\r
 510   "84" => [ "Invalid authorization life cycle", "The authorization life cycle is invalid." ],\r
 511   "86" => [ "Cannot verify PIN", "Cannot verify PIN." ],\r
 512   "87" => [ "Network Unavailable", "Network Unavailable." ],\r
 513   "89" => [ "Ineligible to receive financial position information", "Ineligible to receive financial position information." ],\r
 514   "90" => [ "Cut-off in progress", "Cut-off in progress." ],\r
 515   "91" => [ "Issuer or switch inoperative", "The bank is not available to authorize this transaction." ],\r
 516   "92" => [ "Routing error", "The transaction cannot be routed to the authorizing agency." ],\r
 517   "93" => [ "Violation of law", "Violation of law." ],\r
 518   "94" => [ "Duplicate transaction", "Duplicate transaction." ],\r
 519   "95" => [ "Reconcile error", "Reconcile error." ],\r
 520   "96" => [ "System malfunction", "A system error has occurred." ],\r
 521   "98" => [ "Exceeds cash limit", "Exceeds cash limit." ],\r
 522   "1000" => [ "Unrecoverable error.", "An unrecoverable error has occurred in the ECHONLINE processing." ],\r
 523   "1001" => [ "Account closed", "The merchant account has been closed." ],\r
 524   "1002" => [ "System closed", "Services for this system are not available. (Not used by ECHONLINE)" ],\r
 525   "1003" => [ "E-Mail Down", "The e-mail function is not available. (Not used by ECHONLINE)" ],\r
 526   "1012" => [ "Invalid trans code", "The host computer received an invalid transaction code." ],\r
 527   "1013" => [ "Invalid term id", "The ECHO-ID is invalid." ],\r
 528   "1015" => [ "Invalid card number", "The credit card number that was sent to the host computer was invalid" ],\r
 529   "1016" => [ "Invalid expiry date", "The card has expired or the expiration date was invalid." ],\r
 530   "1017" => [ "Invalid amount", "The dollar amount was less than 1.00 or greater than the maximum allowed for this card." ],\r
 531   "1019" => [ "Invalid state", "The state code was invalid. (Not used by ECHONLINE)" ],\r
 532   "1021" => [ "Invalid service", "The merchant or card holder is not allowed to perform that kind of transaction" ],\r
 533   "1024" => [ "Invalid auth code", "The authorization number presented with this transaction is incorrect. (deposit transactions only)" ],\r
 534   "1025" => [ "Invalid reference number", "The reference number presented with this transaction is incorrect or is not numeric." ],\r
 535   "1029" => [ "Invalid contract number", "The contract number presented with this transaction is incorrect or is not numeric. (Not used by ECHONLINE)" ],\r
 536   "1030" => [ "Invalid inventory data", "The inventory data presented with this transaction is not ASCII \"printable\". (Not used by ECHONLINE)" ],\r
 537   "1508" => [ " ", "Invalid or missing order_type." ],\r
 538   "1509" => [ " ", "The merchant is not approved to submit this order_type." ],\r
 539   "1510" => [ " ", "The merchant is not approved to submit this transaction_type." ],\r
 540   #"1511" => [ " ", "Duplicate transaction attempt (see counterin Part I of this Specification</EM>)." ],\r
 541   "1511" => [ " ", "Duplicate transaction attempt (set counter field?)." ],\r
 542   "1599" => [ " ", "An system error occurred while validating the transaction input." ],\r
 543   "1801" => [ "Return Code \"A\"", "Address matches; ZIP does not match." ],\r
 544   "1802" => [ "Return Code \"W\"", "9-digit ZIP matches; Address does not match." ],\r
 545   "1803" => [ "Return Code \"Z\"", "5-digit ZIP matches; Address does not match." ],\r
 546   "1804" => [ "Return Codes \"U\"", "Issuer unavailable; cannot verify." ],\r
 547   "1805" => [ "Return Code \"R\"", "Retry; system is currently unable to process." ],\r
 548   "1806" => [ "Return Code \"S\" or \"G\"", "Issuer does not support AVS." ],\r
 549   "1807" => [ "Return Code \"N\"", "Nothing matches." ],\r
 550   "1808" => [ "Return Code \"E\"", "Invalid AVS only response." ],\r
 551   "1809" => [ "Return Code \"B\"", "Street address match. Postal code not verified because of incompatible formats." ],\r
 552   "1810" => [ "Return Code \"C\"", "Street address and Postal code not verified because of incompatible formats." ],\r
 553   "1811" => [ "Return Code \"D\"", "Street address match and Postal code match." ],\r
 554   "1812" => [ "Return Code \"I\"", "Address information not verified for international transaction." ],\r
 555   "1813" => [ "Return Code \"M\"", "Street address match and Postal code match." ],\r
 556   "1814" => [ "Return Code \"P\"", "Postal code match. Street address not verified because of incompatible formats." ],\r
 557   "1897" => [ "invalid response", "The host returned an invalid response." ],\r
 558   "1898" => [ "disconnect", "The host unexpectedly disconnected." ],\r
 559   "1899" => [ "timeout", "Timeout waiting for host response." ],\r
 560   "2071" => [ "Call VISA", "An authorization number from the VISA Voice Center is required to approve this transaction." ],\r
 561   "2072" => [ "Call Master Card", "An authorization number from the Master Card Voice Center is required to approve this transaction." ],\r
 562   "2073" => [ "Call Carte Blanche", "An authorization number from the Carte Blanche Voice Center is required to approve this transaction." ],\r
 563   "2074" => [ "Call Diners Club", "An authorization number from the Diners' Club Voice Center is required to approve this transaction." ],\r
 564   "2075" => [ "Call AMEX", "An authorization number from the American Express Voice Center is required to approve this transaction." ],\r
 565   "2076" => [ "Call Discover", "An authorization number from the Discover Voice Center is required to approve this transaction." ],\r
 566   "2078" => [ "Call ECHO", "The merchant must call ECHOCustomer Support for approval.or because there is a problem with the merchant's account." ],\r
 567   "2079" => [ "Call XpresscheX", "The merchant must call ECHOCustomer Support for approval.or because there is a problem with the merchant's account." ],\r
 568   "3001" => [ "No ACK on Resp", "The host did not receive an ACK from the terminal after sending the transaction response." ],\r
 569   "3002" => [ "POS NAK'd 3 Times", "The host disconnected after the terminal replied 3 times to the host response with a NAK." ],\r
 570   "3003" => [ "Drop on Wait", "The line dropped before the host could send a response to the terminal." ],\r
 571   "3005" => [ "Drop on Resp", "The line dropped while the host was sending the response to the terminal." ],\r
 572   "3007" => [ "Drop Before EOT", "The host received an ACK from the terminal but the line dropped before the host could send the EOT." ],\r
 573   "3011" => [ "No Resp to ENQ", "The line was up and carrier detected, but the terminal did not respond to the ENQ." ],\r
 574   "3012" => [ "Drop on Input", "The line disconnected while the host was receiving data from the terminal." ],\r
 575   "3013" => [ "FEP NAK'd 3 Times", "The host disconnected after receiving 3 transmissions with incorrect LRC from the terminal." ],\r
 576   "3014" => [ "No Resp to ENQ", "The line disconnected during input data wait in Multi-Trans Mode." ],\r
 577   "3015" => [ "Drop on Input", "The host encountered a full queue and discarded the input data." ],\r
 578 );\r
 579 for ( 9000..9999 ) {\r
 580   $error{$_} = [ "Host Error", "The host encountered an internal error and was not able to process the transaction." ]; \r
 581 }\r
 582 sub error {\r
 583   my( $self, $num ) = @_;\r
 584   $num =~ s/^00(\d\d)$/$1/;\r
 585   return $num. ': '. $error{$num}[0]. ': '. $error{$num}[1];\r
 586 }\r
 587 \r
 588 1;\r
 589 \r
 590 __END__\r
 591 \r
 592 =head1 NAME\r
 593 \r
 594 Business::OnlinePayment::OpenECHO - ECHO backend module for Business::OnlinePayment\r
 595 \r
 596 =head1 SYNOPSIS\r
 597 \r
 598   use Business::OnlinePayment;\r
 599 \r
 600   ####\r
 601   # One step transaction, the simple case.\r
 602   ####\r
 603 \r
 604   my $tx = new Business::OnlinePayment("OpenECHO");\r
 605   $tx->content(\r
 606       type           => 'VISA',\r
 607       login          => '1234684752',\r
 608       password       => '43400210',\r
 609       action         => 'Normal Authorization',\r
 610       description    => 'Business::OnlinePayment test',\r
 611       amount         => '49.95',\r
 612       invoice_number => '100100',\r
 613       customer_id    => 'jsk',\r
 614       first_name     => 'Tofu',\r
 615       last_name      => 'Beast',\r
 616       address        => '123 Anystreet',\r
 617       city           => 'Anywhere',\r
 618       state          => 'UT',\r
 619       zip            => '84058',\r
 620       card_number    => '4005550000000019',\r
 621       expiration     => '08/06',\r
 622       cvv2           => '1234', #optional\r
 623       referer        => 'http://valid.referer.url/',\r
 624   );\r
 625   $tx->submit();\r
 626 \r
 627   if($tx->is_success()) {\r
 628       print "Card processed successfully: ".$tx->authorization."\n";\r
 629   } else {\r
 630       print "Card was rejected: ".$tx->error_message."\n";\r
 631   }\r
 632 \r
 633 =head1 SUPPORTED TRANSACTION TYPES\r
 634 \r
 635 =head2 CC, Visa, MasterCard, American Express, Discover\r
 636 \r
 637 Content required: type, login, password, action, amount, first_name, last_name, card_number, expiration.\r
 638 \r
 639 =head2 Check\r
 640 \r
 641 Not yet implemented...\r
 642 #Content required: type, login, password, action, amount, first_name, last_name, account_number, routing_code, bank_name.\r
 643 \r
 644 =head1 PREREQUISITES\r
 645 \r
 646   URI::Escape\r
 647   Tie::IxHash\r
 648 \r
 649   Net::SSLeay _or_ ( Crypt::SSLeay and LWP )\r
 650 \r
 651 =head1 DESCRIPTION\r
 652 \r
 653 For detailed information see L<Business::OnlinePayment>.\r
 654 \r
 655 =head1 AUTHOR\r
 656 \r
 657 Original Author\r
 658 Michael Lehmkuhl <michael@electricpulp.com>\r
 659 \r
 660 Special Thanks\r
 661 Jim Darden <jdarden@echo-inc.com>\r
 662 Dan Browning <db@kavod.com>\r
 663 \r
 664 Business::OnlinePayment Implementation\r
 665 Ivan Kohler <ivan-openecho@420.am>\r
 666 \r
 667 =head1 SEE ALSO\r
 668 \r
 669 perl(1). L<Business::OnlinePayment>.\r
 670 \r
 671 =cut\r
 672 \r