1 package Business::OnlinePayment::InternetSecure;
9 use Net::SSLeay qw(make_form post_https);
10 use XML::Simple qw(xml_in xml_out);
12 use base qw(Business::OnlinePayment Exporter);
15 our $VERSION = '0.01';
18 use constant CARD_TYPES => {
21 AX => 'American Express', # FIXME: AM?
27 # Convenience functions to avoid undefs and escape products strings
28 sub _def($) { defined $_[0] ? $_[0] : '' }
29 sub _esc($) { local $_ = shift; tr/|:/ /s; tr/"`/'/s; return $_ }
35 $self->server('secure.internetsecure.com');
37 $self->path('/process.cgi');
40 receipt_number sales_number
44 avs_response cvv2_response
48 # OnlinePayment's get_fields now filters out undefs in 3.x. :(
51 my ($self, @fields) = @_;
53 my %content = $self->content;
55 my %new = map +($_ => $content{$_}), @fields;
60 # OnlinePayment's remap_fields is buggy, so we simply rewrite it
63 my ($self, %map) = @_;
65 my %content = $self->content();
67 $content{$map{$_}} = delete $content{$_};
69 $self->content(%content);
72 # Combine get_fields and remap_fields for convenience
74 sub get_remap_fields {
75 my ($self, %map) = @_;
77 $self->remap_fields(reverse %map);
78 my %data = $self->get_fields(keys %map);
83 # Since there's no standard format for expiration dates, we try to do our best
86 my ($self, $str) = @_;
92 if (/^(\d{4})\W(\d{1,2})$/ || # YYYY.MM or YYYY-M
93 /^(\d\d)\W(\d)$/ || # YY/M or YY-M
94 /^(\d\d)[.-](\d\d)$/) { # YY-MM
96 } elsif (/^(\d{1,2})\W(\d{4})$/ || # MM-YYYY or M/YYYY
97 /^(\d)\W(\d\d)$/ || # M/YY or M-YY
98 /^(\d\d)\/?(\d\d)$/) { # MM/YY or MMYY
101 croak "Unable to parse expiration date: $str";
104 $y += 2000 if $y < 2000; # Aren't we glad Y2K is behind us?
109 # Convert a single product into a product string
112 my ($self, $currency, %data) = @_;
114 croak "Missing amount in product" unless defined $data{amount};
116 my @flags = ($currency);
118 foreach (split ' ' => uc($data{taxes} || '')) {
119 croak "Unknown tax code $_" unless /^(GST|PST|HST)$/;
123 if ($self->test_transaction) {
124 push @flags, $self->test_transaction < 0 ? 'TESTD' : 'TEST';
128 sprintf('%.2f' => $data{amount}),
129 $data{quantity} || 1,
130 _esc _def $data{sku},
131 _esc _def $data{description},
132 join('' => map "{$_}" => @flags),
136 # Generate the XML document for this transaction
141 my %content = $self->content;
143 $self->required_fields(qw(action card_number exp_date));
145 croak 'Unsupported transaction type'
146 if $content{type} && $content{type} !~
147 /^(Visa|MasterCard|American Express|Discover)$/i;
149 croak 'Unsupported action'
150 unless $content{action} =~ /^Normal Authori[zs]ation$/i;
152 $content{currency} = uc($content{currency} || 'CAD');
153 croak "Unknown currency code ", $content{currency}
154 unless $content{currency} =~ /^(CAD|USD)$/;
156 $content{taxes} = uc($content{taxes} || '');
158 my %data = $self->get_remap_fields(qw(
159 xxxCard_Number card_number
171 xxxShippingName ship_name
172 xxxShippingCompany ship_company
173 xxxShippingAddress ship_address
174 xxxShippingCity ship_city
175 xxxShippingProvince ship_state
176 xxxShippingPostal ship_zip
177 xxxShippingCountry ship_country
178 xxxShippingPhone ship_phone
179 xxxShippingEmail ship_email
182 $data{MerchantNumber} = $self->merchant_id;
184 $data{xxxCard_Number} =~ tr/ //d;
185 $data{xxxCard_Number} =~ s/^[^3-6]/4/ if $self->test_transaction;
187 my ($y, $m) = $self->parse_expdate($content{exp_date});
188 $data{xxxCCYear} = sprintf '%.4u' => $y;
189 $data{xxxCCMonth} = sprintf '%.2u' => $m;
191 if (defined $content{cvv2} && $content{cvv2} ne '') {
193 $data{CVV2Indicator} = $content{cvv2};
196 $data{CVV2Indicator} = '';
199 if (ref $content{description}) {
200 $data{Products} = join '|' => map $self->prod_string(
202 taxes => $content{taxes},
204 @{ $content{description} };
206 $self->required_fields(qw(amount));
207 $data{Products} = $self->prod_string(
209 taxes => $content{taxes},
210 amount => $content{amount},
211 description => $content{description},
217 RootName => 'TranxRequest',
218 SuppressEmpty => undef,
219 XMLDecl => '<?xml version="1.0" encoding="utf-8" standalone="yes"?>',
223 # Map the various fields from the response, and put their values into our
224 # object for retrieval.
227 my ($self, $data, %map) = @_;
229 while (my ($k, $v) = each %map) {
231 $self->$v($data->{$k});
235 # Parse the server's response and set various fields
238 my ($self, $response) = @_;
240 $self->server_response($response);
242 $response = xml_in($response,
243 ForceArray => [qw(product flag)],
244 GroupTags => { qw(Products product flags flag) },
246 SuppressEmpty => undef,
249 my $code = $self->result_code($response->{Page});
250 $self->is_success($code eq '2000' || $code eq '90000' || $code eq '900P1');
252 $self->infuse($response, qw(
253 ReceiptNumber receipt_number
254 SalesOrderNumber sales_number
258 ApprovalCode authorization
259 Verbiage error_message
260 TotalAmount total_amount
261 AVSResponseCode avs_response
262 CVV2ResponseCode cvv2_response
265 # Completely undocumented field that sometimes override <Verbiage>
266 $self->error_message($response->{Error}) if $response->{Error};
268 $self->card_type(CARD_TYPES->{$self->card_type});
270 $self->{products_raw} = $response->{Products};
278 croak "Missing required argument 'merchant_id'"
279 unless defined $self->{merchant_id};
281 my ($page, $response, %headers) =
288 xxxRequestMode => 'X',
289 xxxRequestData => Encode::encode_utf8(
295 croak 'Error connecting to server' unless $page;
296 croak 'Server responded, but not in XML' unless $page =~ /^<\?xml/;
298 $self->parse_response($page);
309 Business::OnlinePayment::InternetSecure - InternetSecure backend for Business::OnlinePayment
313 use Business::OnlinePayment;
315 $txn = new Business::OnlinePayment 'InternetSecure',
316 merchant_id => '0000';
319 action => 'Normal Authorization',
322 card_number => '0000000000000000',
323 exp_date => '2004-07',
324 cvv2 => '000', # Optional
326 name => "Fr\x{e9}d\x{e9}ric Bri\x{e8}re",
328 address => '123 Street',
329 city => 'Metropolis',
333 phone => '(555) 555-1212',
334 email => 'fbriere@fbriere.net',
336 description => 'Online purchase',
344 if ($txn->is_success) {
345 print "Card processed successfully: " . $tx->authorization . "\n";
347 print "Card was rejected: " . $tx->error_message . "\n";
352 Business::OnlinePayment::InternetSecure is an implementation of
353 L<Business::OnlinePayment> that allows for processing online credit card
354 payments through InternetSecure.
356 See L<Business::OnlinePayment> for more information about the generic
357 Business::OnlinePayment interface.
361 Object creation is done via L<Business::OnlinePayment>; see its manpage for
362 details. The I<merchant_id> processor option is required, and corresponds
363 to the merchant ID assigned to you by InternetSecure.
367 (Other methods are also available -- see L<Business::OnlinePayment> for more
370 =head2 Before order submission
374 =item content( CONTENT )
376 Sets up the data prior to a transaction (overwriting any previous data by the
377 same occasion). CONTENT is an associative array (hash), containing some of
378 the following fields:
382 =item action (required)
384 What to do with the transaction. Only C<Normal Authorization> is supported
389 Transaction type, being one of the following:
397 =item - American Express
403 (This is actually ignored for the moment, and can be left blank or undefined.)
405 =item card_number (required)
407 Credit card number. Spaces are allowed, and will be automatically removed.
409 =item exp_date (required)
411 Credit card expiration date. Since L<Business::OnlinePayment> does not specify
412 any syntax, this module is rather lax regarding what it will accept. The
413 recommended syntax is I<YYYY-MM>, but forms such as I<MM/YYYY> or I<MMYY> are
418 Three- or four-digit verification code printed on the card. This can be left
419 blank or undefined, in which case no check will be performed. Whether or not a
420 transaction will be declined in case of a mismatch depends on the merchant
421 account configuration.
423 This number may be called Card Verification Value (CVV2), Card Validation
424 Code (CVC2) or Card Identification number (CID), depending on the card issuer.
428 A short description of the purchase. See L<"Products list syntax"> for
429 an alternate syntax that allows a list of products to be specified.
431 =item amount (usually required)
433 Total amount to be billed, excluding taxes if they are to be added separately
436 This field is required if B<description> is a string, but should be left
437 undefined if B<description> contains a list of products instead, as outlined
438 in L<"Products list syntax">.
442 Currency of all amounts for this order. This can currently be either
443 C<CAD> (default) or C<USD>.
447 Taxes to be added automatically to B<amount> by InternetSecure.
449 Available taxes are C<GST>, C<PST> and C<HST>. Multiple taxes can specified
450 by concatenating them with spaces, such as C<GST HST>.
452 =item name / company / address / city / state / zip / country / phone / email
454 Customer information. B<Country> should be a two-letter code taken from ISO
461 =head2 After order submission
465 =item receipt_number()
467 Receipt number of this transaction; this is actually a string, unique to all
468 InternetSecure transactions.
472 Sales order number of this transaction. This is a number, unique to each
473 merchant, which is incremented by 1 each time.
477 Date and time of the transaction. Format is C<YYYY/MM/DD hh:mm:ss>.
481 Total amount billed for this order, including taxes.
485 Type of the credit card used for the submitted order, being one of the
494 =item - American Express
500 =item avs_response() / cvv2_response()
502 Results of the AVS and CVV2 checks. See the InternetSecure documentation for
503 the list of possible values.
515 =head2 Products list syntax
517 Optionally, the B<description> field of B<content()> can contain a reference
518 to an array of products, instead of a simple string. Each element of this
519 array represents a different product, and must be a reference to a hash with
520 the following fields:
526 Unit price of this product.
530 Ordered quantity of this product.
534 Internal code for this product.
538 Description of this product
542 Taxes that should be automatically added to this product. If specified, this
543 overrides the B<taxes> field passed to B<content()>.
547 When using a products list, the B<amount> field passed to B<content()> should
551 =head2 Character encoding
553 Since communication to/from InternetSecure is encoded with UTF-8, all Unicode
554 characters are theoretically available when submitting information via
555 B<submit()>. (Further restrictions may be imposed by InternetSecure itself.)
557 When using non-ASCII characters, all data provided to B<submit()> should either
558 be in the current native encoding (typically latin-1, unless it was modified
559 via the C<encoding> pragma), or be decoded via the C<Encode> module.
560 Conversely, all data returned after calling B<submit()> will be automatically
571 L<Business::OnlinePayment>
575 Frédéric Brière, E<lt>fbriere@fbriere.netE<gt>
577 =head1 COPYRIGHT AND LICENSE
579 Copyright (C) 2006 by Frédéric Brière
581 This library is free software; you can redistribute it and/or modify
582 it under the same terms as Perl itself, either Perl version 5.8.4 or,
583 at your option, any later version of Perl 5 you may have available.