InternetSecure.pm

   1 package Business::OnlinePayment::InternetSecure;
   2
   3 use 5.008;
   4 use strict;
   5 use warnings;
   6
   7 use Carp;
   8 use Encode;
   9 use Net::SSLeay qw(make_form post_https);
  10 use XML::Simple qw(xml_in xml_out);
  11
  12 use base qw(Business::OnlinePayment Exporter);
  13
  14
  15 our $VERSION = '0.01';
  16
  17
  18 use constant CARD_TYPES => {
  19                                 VI => 'Visa',
  20                                 MC => 'MasterCard',
  21                                 AX => 'American Express', # FIXME: AM?
  22                                 NN => 'Discover',
  23                                 # JB?
  24                         };
  25
  26
  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 $_ }
  30
  31
  32 sub set_defaults {
  33         my ($self) = @_;
  34
  35         $self->server('secure.internetsecure.com');
  36         $self->port(443);
  37         $self->path('/process.cgi');
  38
  39         $self->build_subs(qw(
  40                                 receipt_number  sales_order_number
  41                                 card_type
  42                                 total_amount
  43                                 avs_response    cvv2_response
  44                         ));
  45 }
  46
  47 # OnlinePayment's get_fields now filters out undefs in 3.x. :(
  48 #
  49 sub get_fields {
  50         my ($self, @fields) = @_;
  51
  52         my %content = $self->content;
  53
  54         my %new = map +($_ => $content{$_}), @fields;
  55
  56         return %new;
  57 }
  58
  59 # OnlinePayment's remap_fields is buggy, so we simply rewrite it
  60 #
  61 sub remap_fields {
  62         my ($self, %map) = @_;
  63
  64         my %content = $self->content();
  65         foreach (keys %map) {
  66                 $content{$map{$_}} = delete $content{$_};
  67         }
  68         $self->content(%content);
  69 }
  70
  71 # Combine get_fields and remap_fields for convenience
  72 #
  73 sub get_remap_fields {
  74         my ($self, %map) = @_;
  75
  76         $self->remap_fields(reverse %map);
  77         my %data = $self->get_fields(keys %map);
  78
  79         return %data;
  80 }
  81
  82 # Since there's no standard format for expiration dates, we try to do our best
  83 #
  84 sub parse_expdate {
  85         my ($self, $str) = @_;
  86
  87         local $_ = $str;
  88
  89         my ($y, $m);
  90
  91         if (/^(\d{4})\W(\d{1,2})$/ ||           # YYYY.MM  or  YYYY-M
  92                         /^(\d\d)\W(\d)$/ ||     # YY/M  or  YY-M
  93                         /^(\d\d)[.-](\d\d)$/) { # YY-MM
  94                 ($y, $m) = ($1, $2);
  95         } elsif (/^(\d{1,2})\W(\d{4})$/ ||      # MM-YYYY  or  M/YYYY
  96                         /^(\d)\W(\d\d)$/ ||     # M/YY  or  M-YY
  97                         /^(\d\d)\/?(\d\d)$/) {  # MM/YY  or  MMYY
  98                 ($y, $m) = ($2, $1);
  99         } else {
 100                 croak "Unable to parse expiration date: $str";
 101         }
 102
 103         $y += 2000 if $y < 2000;  # Aren't we glad Y2K is behind us?
 104
 105         return ($y, $m);
 106 }
 107
 108 # Convert a single product into a product string
 109 #
 110 sub prod_string {
 111         my ($self, $currency, %data) = @_;
 112
 113         croak "Missing amount in product" unless defined $data{amount};
 114
 115         my @flags = ($currency);
 116
 117         foreach (split ' ' => uc($data{taxes} || '')) {
 118                 croak "Unknown tax code $_" unless /^(GST|PST|HST)$/;
 119                 push @flags, $_;
 120         }
 121
 122         if ($self->test_transaction) {
 123                 push @flags, $self->test_transaction < 0 ? 'TESTD' : 'TEST';
 124         }
 125
 126         return join '::' =>
 127                                 sprintf('%.2f' => $data{amount}),
 128                                 $data{quantity} || 1,
 129                                 _esc _def $data{sku},
 130                                 _esc _def $data{description},
 131                                 join('' => map "{$_}" => @flags),
 132                                 ;
 133 }
 134
 135 # Generate the XML document for this transaction
 136 #
 137 sub to_xml {
 138         my ($self) = @_;
 139
 140         my %content = $self->content;
 141
 142         $self->required_fields(qw(action card_number exp_date));
 143
 144         croak 'Unsupported transaction type'
 145                 if $content{type} && $content{type} !~
 146                         /^(Visa|MasterCard|American Express|Discover)$/i;
 147
 148         croak 'Unsupported action'
 149                 unless $content{action} =~ /^Normal Authori[zs]ation$/i;
 150
 151         $content{currency} ||= 'CAD';
 152         $content{currency} = uc $content{currency};
 153         croak "Unknown currency code ", $content{currency}
 154                 unless $content{currency} =~ /^(CAD|USD)$/;
 155
 156         $content{taxes} ||= '';
 157         $content{taxes} = uc $content{taxes};
 158
 159         my %data = $self->get_remap_fields(qw(
 160                         xxxCard_Number          card_number
 161
 162                         xxxName                 name
 163                         xxxCompany              company
 164                         xxxAddress              address
 165                         xxxCity                 city
 166                         xxxProvince             state
 167                         xxxPostal               zip
 168                         xxxCountry              country
 169                         xxxPhone                phone
 170                         xxxEmail                email
 171
 172                         xxxShippingName         ship_name
 173                         xxxShippingCompany      ship_company
 174                         xxxShippingAddress      ship_address
 175                         xxxShippingCity         ship_city
 176                         xxxShippingProvince     ship_state
 177                         xxxShippingPostal       ship_zip
 178                         xxxShippingCountry      ship_country
 179                         xxxShippingPhone        ship_phone
 180                         xxxShippingEmail        ship_email
 181                 ));
 182
 183         $data{MerchantNumber} = $self->merchant_id;
 184
 185         $data{xxxCard_Number} =~ tr/ //d;
 186         $data{xxxCard_Number} =~ s/^[0-36-9]/4/ if $self->test_transaction;
 187
 188         my ($y, $m) = $self->parse_expdate($content{exp_date});
 189         $data{xxxCCYear} = sprintf '%.4u' => $y;
 190         $data{xxxCCMonth} = sprintf '%.2u' => $m;
 191
 192         if (defined $content{cvv2} && $content{cvv2} ne '') {
 193                 $data{CVV2} = 1;
 194                 $data{CVV2Indicator} = $content{cvv2};
 195         } else {
 196                 $data{CVV2} = 0;
 197                 $data{CVV2Indicator} = '';
 198         }
 199
 200         if (ref $content{description}) {
 201                 $data{Products} = join '|' => map $self->prod_string(
 202                                                 $content{currency},
 203                                                 taxes => $content{taxes},
 204                                                 %$_),
 205                                         @{ $content{description} };
 206         } else {
 207                 $self->required_fields(qw(amount));
 208                 $data{Products} = $self->prod_string(
 209                                         $content{currency},
 210                                         taxes       => $content{taxes},
 211                                         amount      => $content{amount},
 212                                         description => $content{description},
 213                                 );
 214         }
 215
 216         xml_out(\%data,
 217                 NoAttr => 1,
 218                 RootName => 'TranxRequest',
 219                 SuppressEmpty => undef,
 220                 XMLDecl => '<?xml version="1.0" encoding="utf-8" standalone="yes"?>',
 221         );
 222 }
 223
 224 # Map the various fields from the response, and put their values into our
 225 # object for retrieval.
 226 #
 227 sub infuse {
 228         my ($self, $data, %map) = @_;
 229
 230         while (my ($k, $v) = each %map) {
 231                 no strict 'refs';
 232                 $self->$v($data->{$k});
 233         }
 234 }
 235
 236 # Parse the server's response and set various fields
 237 #
 238 sub parse_response {
 239         my ($self, $response) = @_;
 240
 241         $self->server_response($response);
 242
 243         $response = xml_in($response,
 244                         ForceArray => [qw(product flag)],
 245                         GroupTags => { qw(Products product flags flag) },
 246                         KeyAttr => [],
 247                         SuppressEmpty => undef,
 248                 );
 249
 250         my $code = $self->result_code($response->{Page});
 251         $self->is_success($code eq '2000' || $code eq '90000' || $code eq '900P1');
 252
 253         $self->infuse($response, qw(
 254                         ReceiptNumber           receipt_number
 255                         SalesOrderNumber        sales_order_number
 256                         CardType                card_type
 257                         Page                    result_code
 258                         ApprovalCode            authorization
 259                         Verbiage                error_message
 260                         TotalAmount             total_amount
 261                         AVSResponseCode         avs_response
 262                         CVV2ResponseCode        cvv2_response
 263                 ));
 264
 265         # Completely undocumented field that sometimes override <Verbiage>
 266         $self->error_message($response->{Error}) if $response->{Error};
 267
 268         $self->card_type(CARD_TYPES->{$self->card_type});
 269
 270         $self->{products_raw} = $response->{Products};
 271
 272         return $self;
 273 }
 274
 275 sub submit {
 276         my ($self) = @_;
 277
 278         croak "Missing required argument 'merchant_id'"
 279                 unless defined $self->{merchant_id};
 280
 281         my ($page, $response, %headers) =
 282                 post_https(
 283                                 $self->server,
 284                                 $self->port,
 285                                 $self->path,
 286                                 undef,
 287                                 make_form(
 288                                         xxxRequestMode => 'X',
 289                                         xxxRequestData => Encode::encode_utf8(
 290                                                                 $self->to_xml
 291                                                           ),
 292                                 )
 293                         );
 294
 295         croak 'Error connecting to server' unless $page;
 296         croak 'Server responded, but not in XML' unless $page =~ /^<\?xml/;
 297
 298         $self->parse_response($page);
 299 }
 300
 301
 302 1;
 303
 304 __END__
 305
 306
 307 =head1 NAME
 308
 309 Business::OnlinePayment::InternetSecure - InternetSecure backend for Business::OnlinePayment
 310
 311 =head1 SYNOPSIS
 312
 313   use Business::OnlinePayment;
 314
 315   $txn = new Business::OnlinePayment 'InternetSecure',
 316                                         merchant_id => '0000';
 317
 318   $txn->content(
 319         action          => 'Normal Authorization',
 320
 321         type            => 'Visa',
 322         card_number     => '0000000000000000',
 323         exp_date        => '2004-07',
 324         cvv2            => '000',               # Optional
 325
 326         name            => "Fr\x{e9}d\x{e9}ric Bri\x{e8}re",
 327         company         => '',
 328         address         => '123 Street',
 329         city            => 'Metropolis',
 330         state           => 'ZZ',
 331         zip             => 'A1A 1A1',
 332         country         => 'CA',
 333         phone           => '(555) 555-1212',
 334         email           => 'fbriere@fbriere.net',
 335
 336         description     => 'Online purchase',
 337         amount          => 49.95,
 338         currency        => 'CAD',
 339         taxes           => 'GST PST',
 340         );
 341
 342   $txn->submit;
 343
 344   if ($txn->is_success) {
 345         print "Card processed successfully: " . $tx->authorization . "\n";
 346   } else {
 347         print "Card was rejected: " . $tx->error_message . "\n";
 348   }
 349
 350 =head1 DESCRIPTION
 351
 352 Business::OnlinePayment::InternetSecure is an implementation of
 353 L<Business::OnlinePayment> that allows for processing online credit card
 354 payments through InternetSecure.
 355
 356 See L<Business::OnlinePayment> for more information about the generic
 357 Business::OnlinePayment interface.
 358
 359 =head1 CREATOR
 360
 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.
 364
 365 =head1 METHODS
 366
 367 (See L<Business::OnlinePayment> for more methods.)
 368
 369 =head2 Before order submission
 370
 371 =over 4
 372
 373 =item content( CONTENT )
 374
 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:
 378
 379 =over 4
 380
 381 =item action (required)
 382
 383 What to do with the transaction.  Only C<Normal Authorization> is supported
 384 for the moment.
 385
 386 =item type
 387
 388 Transaction type, being one of the following:
 389
 390 =over 4
 391
 392 =item - Visa
 393
 394 =item - MasterCard
 395
 396 =item - American Express
 397
 398 =item - Discover
 399
 400 =back
 401
 402 (This is actually ignored for the moment, and can be left blank or undefined.)
 403
 404 =item card_number (required)
 405
 406 Credit card number.  Spaces are allowed, and will be automatically removed.
 407
 408 =item exp_date (required)
 409
 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
 413 allowed as well.
 414
 415 =item cvv2
 416
 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.
 421
 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.
 424
 425 =item description
 426
 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.
 429
 430 =item amount
 431
 432 Total amount to be billed, excluding taxes if they are to be added separately.
 433 This field is required if B<description> is a string, and should be left
 434 undefined if B<description> contains a list of products, as outlined in
 435 L<"Products list syntax">.
 436
 437 =item currency
 438
 439 Currency of all amounts for this order.  This can currently be either
 440 C<CAD> (default) or C<USD>.
 441
 442 =item taxes
 443
 444 Taxes to be added automatically.  These should not be included in B<amount>;
 445 they will be automatically added by InternetSecure later on.
 446
 447 Available taxes are C<GST>, C<PST> and C<HST>.  Taxes can be combined by
 448 separating them with spaces, such as C<GST HST>.
 449
 450 =item name / company / address / city / state / zip / country / phone / email
 451
 452 Customer information.  B<Country> should be a two-letter code taken from ISO
 453 3166-1.
 454
 455 =back
 456
 457 =back
 458
 459 =head2 After order submission
 460
 461 =over 4
 462
 463 =item receipt_number() / sales_order_number()
 464
 465 Receipt number and sales order number of submitted order.
 466
 467 =item total_amount()
 468
 469 Total amount billed for this order, including taxes.
 470
 471 =item card_type()
 472
 473 Type of the credit card used for the submitted order, being one of the
 474 following:
 475
 476 =over 4
 477
 478 =item - Visa
 479
 480 =item - MasterCard
 481
 482 =item - American Express
 483
 484 =item - Discover
 485
 486 =back
 487
 488 =item avs_response() / cvv2_response()
 489
 490 Results of the AVS and CVV2 checks.  See the InternetSecure documentation for
 491 the list of possible values.
 492
 493 =item products_raw()
 494
 495 ...
 496
 497
 498 =back
 499
 500
 501 =head1 NOTES
 502
 503 =head2 Products list syntax
 504
 505 Optionally, the B<description> field of B<content()> can contain a reference
 506 to an array of products, instead of a simple string.  Each element of this
 507 array represents a different product, and must be a reference to a hash with
 508 the following fields:
 509
 510 =over 4
 511
 512 =item amount
 513
 514 Unit price of this product.
 515
 516 =item quantity
 517
 518 Ordered quantity of this product.
 519
 520 =item sku
 521
 522 Internal code for this product.
 523
 524 =item description
 525
 526 Description of this product
 527
 528 =item taxes
 529
 530 Taxes that should be automatically added to this product.  If specified, this
 531 overrides the B<taxes> field passed to B<content()>.
 532
 533 =back
 534
 535 When using a products list, the B<amount> field passed to B<content()> should
 536 be left undefined.
 537
 538
 539 =head2 Character encoding
 540
 541 Since communication to/from InternetSecure is encoded with UTF-8, all Unicode
 542 characters are theoretically available when submitting information via
 543 B<submit()>.  (Further restrictions may be imposed by InternetSecure itself.)
 544
 545 When using non-ASCII characters, all data provided to B<submit()> should either
 546 be in the current native encoding (typically latin-1, unless it was modified
 547 via the C<encoding> pragma), or be decoded via the C<Encode> module.
 548 Conversely, all data returned after calling B<submit()> will be automatically
 549 decoded.
 550
 551
 552 =head1 EXPORT
 553
 554 None by default.
 555
 556
 557 =head1 SEE ALSO
 558
 559 L<Business::OnlinePayment>
 560
 561 =head1 AUTHOR
 562
 563 Frédéric Brière, E<lt>fbriere@fbriere.netE<gt>
 564
 565 =head1 COPYRIGHT AND LICENSE
 566
 567 Copyright (C) 2006 by Frédéric Brière
 568
 569 This library is free software; you can redistribute it and/or modify
 570 it under the same terms as Perl itself, either Perl version 5.8.4 or,
 571 at your option, any later version of Perl 5 you may have available.
 572
 573
 574 =cut