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},
218 RootName => 'TranxRequest',
219 SuppressEmpty => undef,
220 XMLDecl => '<?xml version="1.0" encoding="utf-8" standalone="yes"?>',
224 # Map the various fields from the response, and put their values into our
225 # object for retrieval.
228 my ($self, $data, %map) = @_;
230 while (my ($k, $v) = each %map) {
232 $self->$v($data->{$k});
236 # Parse the server's response and set various fields
239 my ($self, $response) = @_;
241 $self->server_response($response);
243 $response = xml_in($response,
244 ForceArray => [qw(product flag)],
245 GroupTags => { qw(Products product flags flag) },
247 SuppressEmpty => undef,
250 my $code = $self->result_code($response->{Page});
251 $self->is_success($code eq '2000' || $code eq '90000' || $code eq '900P1');
253 $self->infuse($response, qw(
254 ReceiptNumber receipt_number
255 SalesOrderNumber sales_number
259 ApprovalCode authorization
260 Verbiage error_message
261 TotalAmount total_amount
262 AVSResponseCode avs_response
263 CVV2ResponseCode cvv2_response
266 # Completely undocumented field that sometimes override <Verbiage>
267 $self->error_message($response->{Error}) if $response->{Error};
269 $self->card_type(CARD_TYPES->{$self->card_type});
271 $self->{products_raw} = $response->{Products};
279 croak "Missing required argument 'merchant_id'"
280 unless defined $self->{merchant_id};
282 my ($page, $response, %headers) =
289 xxxRequestMode => 'X',
290 xxxRequestData => $self->to_xml,
294 croak 'Error connecting to server' unless $page;
295 croak 'Server responded, but not in XML' unless $page =~ /^<\?xml/;
297 $self->parse_response($page);
308 Business::OnlinePayment::InternetSecure - InternetSecure backend for Business::OnlinePayment
312 use Business::OnlinePayment;
314 $txn = new Business::OnlinePayment 'InternetSecure',
315 merchant_id => '0000';
318 action => 'Normal Authorization',
321 card_number => '0000000000000000',
322 exp_date => '2004-07',
323 cvv2 => '000', # Optional
325 name => "Fr\x{e9}d\x{e9}ric Bri\x{e8}re",
327 address => '123 Street',
328 city => 'Metropolis',
332 phone => '(555) 555-1212',
333 email => 'fbriere@fbriere.net',
335 description => 'Online purchase',
343 if ($txn->is_success) {
344 print "Card processed successfully: " . $tx->authorization . "\n";
346 print "Card was rejected: " . $tx->error_message . "\n";
351 Business::OnlinePayment::InternetSecure is an implementation of
352 L<Business::OnlinePayment> that allows for processing online credit card
353 payments through InternetSecure.
355 See L<Business::OnlinePayment> for more information about the generic
356 Business::OnlinePayment interface.
360 Object creation is done via L<Business::OnlinePayment>; see its manpage for
361 details. The I<merchant_id> processor option is required, and corresponds
362 to the merchant ID assigned to you by InternetSecure.
366 (Other methods are also available -- see L<Business::OnlinePayment> for more
369 =head2 Before order submission
373 =item content( CONTENT )
375 Sets up the data prior to a transaction (overwriting any previous data by the
376 same occasion). CONTENT is an associative array (hash), containing some of
377 the following fields:
381 =item action (required)
383 What to do with the transaction. Only C<Normal Authorization> is supported
388 Transaction type, being one of the following:
396 =item - American Express
402 (This is actually ignored for the moment, and can be left blank or undefined.)
404 =item card_number (required)
406 Credit card number. Spaces are allowed, and will be automatically removed.
408 =item exp_date (required)
410 Credit card expiration date. Since L<Business::OnlinePayment> does not specify
411 any syntax, this module is rather lax regarding what it will accept. The
412 recommended syntax is I<YYYY-MM>, but forms such as I<MM/YYYY> or I<MMYY> are
417 Three- or four-digit verification code printed on the card. This can be left
418 blank or undefined, in which case no check will be performed. Whether or not a
419 transaction will be declined in case of a mismatch depends on the merchant
420 account configuration.
422 This number may be called Card Verification Value (CVV2), Card Validation
423 Code (CVC2) or Card Identification number (CID), depending on the card issuer.
427 A short description of the purchase. See L<"Products list syntax"> for
428 an alternate syntax that allows a list of products to be specified.
430 =item amount (usually required)
432 Total amount to be billed, excluding taxes if they are to be added separately
435 This field is required if B<description> is a string, but should be left
436 undefined if B<description> contains a list of products instead, as outlined
437 in L<"Products list syntax">.
441 Currency of all amounts for this order. This can currently be either
442 C<CAD> (default) or C<USD>.
446 Taxes to be added automatically to B<amount> by InternetSecure.
448 Available taxes are C<GST>, C<PST> and C<HST>. Multiple taxes can specified
449 by concatenating them with spaces, such as C<GST HST>.
451 =item name / company / address / city / state / zip / country / phone / email
453 Customer information. B<Country> should be a two-letter code taken from ISO
460 =head2 After order submission
464 =item receipt_number()
466 Receipt number of this transaction; this is actually a string, unique to all
467 InternetSecure transactions.
471 Sales order number of this transaction. This is a number, unique to each
472 merchant, which is incremented by 1 each time.
476 Date and time of the transaction. Format is C<YYYY/MM/DD hh:mm:ss>.
480 Total amount billed for this order, including taxes.
484 Type of the credit card used for the submitted order, being one of the
493 =item - American Express
499 =item avs_response() / cvv2_response()
501 Results of the AVS and CVV2 checks. See the InternetSecure documentation for
502 the list of possible values.
514 =head2 Products list syntax
516 Optionally, the B<description> field of B<content()> can contain a reference
517 to an array of products, instead of a simple string. Each element of this
518 array represents a different product, and must be a reference to a hash with
519 the following fields:
525 Unit price of this product.
529 Ordered quantity of this product.
533 Internal code for this product.
537 Description of this product
541 Taxes that should be automatically added to this product. If specified, this
542 overrides the B<taxes> field passed to B<content()>.
546 When using a products list, the B<amount> field passed to B<content()> should
550 =head2 Character encoding
552 Since communication to/from InternetSecure is encoded with UTF-8, all Unicode
553 characters are theoretically available when submitting information via
554 B<submit()>. (Further restrictions may be imposed by InternetSecure itself.)
556 When using non-ASCII characters, all data provided to B<submit()> should either
557 be in the current native encoding (typically latin-1, unless it was modified
558 via the C<encoding> pragma), or be decoded via the C<Encode> module.
559 Conversely, all data returned after calling B<submit()> will be automatically
570 L<Business::OnlinePayment>
574 Frédéric Brière, E<lt>fbriere@fbriere.netE<gt>
576 =head1 COPYRIGHT AND LICENSE
578 Copyright (C) 2006 by Frédéric Brière
580 This library is free software; you can redistribute it and/or modify
581 it under the same terms as Perl itself, either Perl version 5.8.4 or,
582 at your option, any later version of Perl 5 you may have available.