1 package Business::OnlinePayment::WesternACH;
5 use Business::OnlinePayment 3;
6 use Business::OnlinePayment::HTTPS;
9 use Date::Format 'time2str';
10 use Date::Parse 'str2time';
11 use vars qw($VERSION @ISA $me $DEBUG);
13 @ISA = qw(Business::OnlinePayment::HTTPS);
15 $me = 'Business::OnlinePayment::WesternACH';
23 tender_type => 'check',
28 my $required = { map { $_ => 1 } ( qw(
42 # Structure of the XML request document
43 # Right sides of the hash entries are Business::OnlinePayment
44 # field names. Those that start with _ are local method names.
49 password => 'password',
54 TransactionRequest => {
59 type => '_payment_type',
61 # effective date: not supported
63 type => 'tender_type',
65 InvoiceNumber => { value => 'invoice_number' },
66 AccountHolder => { value => '_full_name' },
67 Address => { value => 'address' },
68 ClientID => { value => 'customer_id' },
69 UserDefinedID => { value => 'email' },
71 routing => 'routing_code',
72 account => 'account_number',
73 check => 'check_number',
74 type => '_check_type',
75 verification => 'check_ver',
77 Authorization => { schedule => 'schedule' },
78 SECCode => { value => 'sec_code' },
85 my $returns_request = {
86 TransactionRequest => {
100 $self->server('www.webcheckexpress.com');
102 $self->path('/requester.php');
108 $Business::OnlinePayment::HTTPS::DEBUG = $DEBUG;
111 if ($self->{_content}->{command} eq 'get_returns') {
112 # Setting get_returns overrides anything else.
113 $xml_request = XMLout($self->build($returns_request), KeepRoot => 1);
116 # Error-check and prepare as a normal transaction.
119 # Return-with-error situations
120 croak "Unsupported transaction type: '" . $self->transaction_type . "'"
121 if(not $self->transaction_type =~ /^e?check$/i);
123 croak "Unsupported action: '" . $self->{_content}->{action} . "'"
124 if(!defined($self->_payment_type));
126 croak 'Test transactions not supported'
127 if($self->test_transaction());
131 $self->is_success(0);
132 $self->error_message($@);
136 $xml_request = XMLout($self->build($request), KeepRoot => 1);
139 my ($xml_reply, $response, %reply_headers) = $self->https_post({ 'Content-Type' => 'text/xml' }, $xml_request);
141 if(not $response =~ /^200/) {
142 croak "HTTPS error: '$response'";
145 $self->server_response($xml_reply);
146 my $reply = XMLin($xml_reply, KeepRoot => 1)->{TransactionResponse};
148 if(exists($reply->{Response})) {
149 $self->is_success( ( $reply->{Response}->{status} eq 'successful') ? 1 : 0);
150 $self->error_message($reply->{Response}->{ErrorMessage});
151 if(exists($reply->{Response}->{TransactionID})) {
152 # get_returns puts its results here
153 my $tid = $reply->{Response}->{TransactionID};
154 if($self->{_content}->{command} eq 'get_returns') {
155 if(ref($tid) eq 'ARRAY') {
156 $self->{_content}->{returns} = [ map { $_->{value} } @$tid ];
159 $self->{_content}->{returns} = [ $tid->{value} ];
162 else { # It's not get_returns
163 $self->authorization($tid->{value});
167 elsif(exists($reply->{FatalException})) {
168 $self->is_success(0);
169 $self->error_message($reply->{FatalException});
172 $DB::single = 1 if $DEBUG;
179 my $content = $self->{_content};
180 if(exists($content->{'command'})) {
181 croak 'get_returns: command is already set on this transaction';
183 if ($content->{'returns_method'} eq 'transret') {
184 $Business::OnlinePayment::HTTPS::DEBUG = $DEBUG;
185 if (defined($content->{'login'}) and defined($content->{'password'})) {
186 # date range doesn't work quite right with transret
187 my $path = ('transret.php?style=csv&sort=id&date=');
188 my $starttime = str2time($self->_start);
189 my $endtime = str2time($self->_end) - 1;
191 my @months = map { s/^(....)(..)$/$1-$2-01/; $_ } (
192 time2str('%Y%m', $starttime)..time2str('%Y%m', $endtime)
195 Authorization => 'Basic ' . MIME::Base64::encode($content->{'login'} . ':' . $content->{'password'})
198 foreach my $m (@months) {
199 $self->path($path . $m);
200 my ($page, $reply, %headers) =
202 { headers => $headers },
205 if ($reply =~ /^200/) {
206 $self->is_success(1);
209 $self->error_message($reply);
210 carp $page if $DEBUG > 1;
211 $self->is_success(0);
214 foreach my $trans (split("\cJ", $page)) {
215 my @fields = split(',', $trans);
217 # id, Date Returned, Type, Amount, Name, Customer ID Number, Email Address, Invoice Number, Status Code, SEC
218 # we only care about id and date.
219 next if scalar(@fields) < 10;
220 next if not($fields[0] =~ /^\d+$/);
221 my $rettime = str2time($fields[1]);
222 next if (!$rettime or $rettime < $starttime or $rettime > $endtime);
223 carp $trans if $DEBUG > 1;
224 push @tids, $fields[0];
230 croak 'login and password required';
234 $content->{'command'} = 'get_returns';
236 if($self->is_success) {
237 if(exists($content->{'returns'})) {
238 return @{$content->{'returns'}};
244 # you need to check error_message() for details.
252 my $content = { $self->content };
255 if (ref($skel) ne 'HASH') { croak 'Failed to build non-hash' };
256 foreach my $k (keys(%$skel)) {
257 my $val = $skel->{$k};
258 # Rules for building from the skeleton:
259 # 1. If the value is a hashref, build it recursively.
260 if(ref($val) eq 'HASH') {
261 $data->{$k} = $self->build($val);
263 # 2. If the value starts with an underscore, it's treated as a method name.
264 elsif($val =~ /^_/ and $self->can($val)) {
265 $data->{$k} = $self->can($val)->($self);
267 # 3. If the value is undefined, keep it undefined.
268 elsif(!defined($val)) {
271 # 4. If the value is the name of a key in $self->content, look up that value.
272 elsif(exists($content->{$val})) {
273 $data->{$k} = $content->{$val};
275 # 5. If the value is a key in $defaults, use that value.
276 elsif(exists($defaults->{$val})) {
277 $data->{$k} = $defaults->{$val};
279 # 6. If the value is not required, use an empty string.
280 elsif(! $required->{$val}) {
285 croak "Missing request field: '$val'";
292 # For testing build().
294 return XMLout($self->build($request), KeepRoot => 1);
299 my $action = $self->{_content}->{action};
300 if(!defined($action) or $action =~ /^normal authorization$/i) {
303 elsif($action =~ /^credit$/i) {
313 my $type = $self->{_content}->{account_type};
314 return 'checking' if($type =~ /checking/i);
315 return 'savings' if($type =~ /savings/i);
316 croak "Invalid account_type: '$type'";
321 return join(' ',$self->{_content}->{first_name},$self->{_content}->{last_name});
326 if($self->{_content}->{start}) {
327 my $start = time2str('%Y-%m-%d', str2time($self->{_content}->{start}));
328 croak "Invalid start date: '".$self->{_content}->{start} if !$start;
332 return time2str('%Y-%m-%d', time - 86400);
338 my $end = $self->{_content}->{end};
340 $end = time2str('%Y-%m-%d', str2time($end));
341 croak "Invalid end date: '".$self->{_content}->{end} if !$end;
345 return time2str('%Y-%m-%d', time);
354 Business::OnlinePayment::WesternACH - Western ACH backend for Business::OnlinePayment
358 use Business::OnlinePayment;
361 # Electronic check authorization. We only support
362 # 'Normal Authorization' and 'Credit'.
365 my $tx = new Business::OnlinePayment("WesternACH");
368 login => 'testdrive',
369 password => 'testpass',
370 action => 'Normal Authorization',
371 description => 'Business::OnlinePayment test',
373 invoice_number => '100100',
374 first_name => 'Jason',
375 last_name => 'Kohles',
376 address => '123 Anystreet',
380 account_type => 'personal checking',
381 account_number => '1000468551234',
382 routing_code => '707010024',
383 check_number => '1001', # optional
387 if($tx->is_success()) {
388 print "Check processed successfully: ".$tx->authorization."\n";
390 print "Check was rejected: ".$tx->error_message."\n";
393 my $tx = new Business::OnlinePayment("WesternACH");
395 login => 'testdrive',
396 password => 'testpass',
397 start => '2009-06-25', # optional; defaults to yesterday
398 end => '2009-06-26', # optional; defaults to today
403 =head1 SUPPORTED TRANSACTION TYPES
407 Content required: type, login, password|transaction_key, action, amount, first_name, last_name, account_number, routing_code, account_type.
411 For detailed information see L<Business::OnlinePayment>.
413 =head1 METHODS AND FUNCTIONS
415 See L<Business::OnlinePayment> for the complete list. The following methods either override the methods in L<Business::OnlinePayment> or provide additional functions.
419 Currently returns nothing; these transactions don't seem to have result codes.
423 Returns the response reason text. This can come from several locations in the response document or from certain local errors.
425 =head2 server_response
427 Returns the complete response from the server.
429 =head1 Handling of content(%content) data:
433 The following actions are valid:
440 Mark Wells <mark@freeside.biz> with advice from Ivan Kohler <ivan-westernach@freeside.biz>.
444 perl(1). L<Business::OnlinePayment>.