Rewrote docs a bit

[Business-OnlinePayment-InternetSecure.git] / InternetSecure.pm

diff --git a/InternetSecure.pm b/InternetSecure.pm
index a2c7fab..591c98d 100755 (executable)
--- a/InternetSecure.pm
+++ b/InternetSecure.pm
@@ -37,8 +37,8 @@ sub set_defaults {
        $self->path('/process.cgi');
 
        $self->build_subs(qw(
-                               receipt_number  sales_order_number
-                               cardholder      card_type
+                               receipt_number  sales_number
+                               card_type
                                total_amount
                                avs_response    cvv2_response
                        ));
@@ -108,14 +108,13 @@ sub parse_expdate {
 # Convert a single product into a product string
 #
 sub prod_string {
-       my ($self, $currency, $taxes, %data) = @_;
+       my ($self, $currency, %data) = @_;
 
        croak "Missing amount in product" unless defined $data{amount};
 
        my @flags = ($currency);
 
-       $taxes = uc $data{taxes} if defined $data{taxes};
-       foreach (split ' ' => $taxes) {
+       foreach (split ' ' => uc($data{taxes} || '')) {
                croak "Unknown tax code $_" unless /^(GST|PST|HST)$/;
                push @flags, $_;
        }
@@ -149,13 +148,11 @@ sub to_xml {
        croak 'Unsupported action'
                unless $content{action} =~ /^Normal Authori[zs]ation$/i;
        
-       $content{currency} ||= 'CAD';
-       $content{currency} = uc $content{currency};
+       $content{currency} = uc($content{currency} || 'CAD');
        croak "Unknown currency code ", $content{currency}
                unless $content{currency} =~ /^(CAD|USD)$/;
        
-       $content{taxes} ||= '';
-       $content{taxes} = uc $content{taxes};
+       $content{taxes} = uc($content{taxes} || '');
 
        my %data = $self->get_remap_fields(qw(
                        xxxCard_Number          card_number
@@ -200,16 +197,16 @@ sub to_xml {
        
        if (ref $content{description}) {
                $data{Products} = join '|' => map $self->prod_string(
-                                                       $content{currency},
-                                                       $content{taxes},
-                                                       %$_),
-                                               @{ $content{description} };
+                                               $content{currency},
+                                               taxes => $content{taxes},
+                                               %$_),
+                                       @{ $content{description} };
        } else {
                $self->required_fields(qw(amount));
                $data{Products} = $self->prod_string(
                                        $content{currency},
-                                       $content{taxes},
-                                       amount => $content{amount},
+                                       taxes       => $content{taxes},
+                                       amount      => $content{amount},
                                        description => $content{description},
                                );
        }
@@ -253,8 +250,7 @@ sub parse_response {
 
        $self->infuse($response, qw(
                        ReceiptNumber           receipt_number
-                       SalesOrderNumber        sales_order_number
-                       xxxName                 cardholder
+                       SalesOrderNumber        sales_number
                        CardType                card_type
                        Page                    result_code
                        ApprovalCode            authorization
@@ -264,6 +260,9 @@ sub parse_response {
                        CVV2ResponseCode        cvv2_response
                ));
        
+       # Completely undocumented field that sometimes override <Verbiage>
+       $self->error_message($response->{Error}) if $response->{Error};
+       
        $self->card_type(CARD_TYPES->{$self->card_type});
        
        $self->{products_raw} = $response->{Products};
@@ -363,7 +362,8 @@ to the merchant ID assigned to you by InternetSecure.
 
 =head1 METHODS
 
-(See L<Business::OnlinePayment> for more methods.)
+(Other methods are also available -- see L<Business::OnlinePayment> for more
+details.)
 
 =head2 Before order submission
 
@@ -426,12 +426,14 @@ Code (CVC2) or Card Identification number (CID), depending on the card issuer.
 A short description of the purchase.  See L<"Products list syntax"> for
 an alternate syntax that allows a list of products to be specified.
 
-=item amount
+=item amount (usually required)
 
-Total amount to be billed, excluding taxes if they are to be added separately.
-This field is required if B<description> is a string, and should be left
-undefined if B<description> contains a list of products, as outlined in
-L<"Products list syntax">.
+Total amount to be billed, excluding taxes if they are to be added separately
+by InternetSecure.
+
+This field is required if B<description> is a string, but should be left
+undefined if B<description> contains a list of products instead, as outlined
+in L<"Products list syntax">.
 
 =item currency
 
@@ -440,17 +442,15 @@ C<CAD> (default) or C<USD>.
 
 =item taxes
 
-Taxes to be added automatically.  These should not be included in B<amount>;
-they will be automatically added by InternetSecure later on.
+Taxes to be added automatically to B<amount> by InternetSecure.
 
-Available taxes are C<GST>, C<PST> and C<HST>.  Taxes can be combined by
-separating them with spaces, such as C<GST HST>.
+Available taxes are C<GST>, C<PST> and C<HST>.  Multiple taxes can specified
+by concatenating them with spaces, such as C<GST HST>.
 
 =item name / company / address / city / state / zip / country / phone / email
 
-Facultative customer information.  B<state> should be either a postal
-abbreviation or a two-letter code taken from ISO 3166-2, and B<country> should
-be a two-letter code taken from ISO 3166-1.
+Customer information.  B<Country> should be a two-letter code taken from ISO
+3166-1.
 
 =back
 
@@ -460,18 +460,19 @@ be a two-letter code taken from ISO 3166-1.
 
 =over 4
 
-=item receipt_number() / sales_order_number()
+=item receipt_number()
 
-Receipt number and sales order number of submitted order.
+Receipt number of this transaction; this is actually a string, unique to all
+InternetSecure transactions.
 
-=item total_amount()
+=item sales_number()
 
-Total amount billed for this order, including taxes.
+Sales order number of this transaction.  This is a number, unique to each
+merchant, which is incremented by 1 each time.
 
-=item cardholder()
+=item total_amount()
 
-Cardholder's name.  This is currently a mere copy of the B<name> field passed
-to B<submit()>.
+Total amount billed for this order, including taxes.
 
 =item card_type()
 
@@ -520,7 +521,7 @@ Unit price of this product.
 
 =item quantity
 
-Ordered quantity of this product.  This can be a decimal value.
+Ordered quantity of this product.
 
 =item sku