Partial authorizations

[Business-OnlinePayment.git] / OnlinePayment.pm

diff --git a/OnlinePayment.pm b/OnlinePayment.pm
index eff1ec6..7719cab 100644 (file)
--- a/OnlinePayment.pm
+++ b/OnlinePayment.pm
@@ -19,6 +19,7 @@ my @methods = qw(
     failure_status
     fraud_detect
     is_success
+    partial_auth_amount
     maximum_risk
     path
     port
@@ -35,8 +36,6 @@ my @methods = qw(
     response_page
     avs_code
     cvv2_response
-    partial_auth
-    partial_auth_amount
 );
 
 __PACKAGE__->build_subs(@methods);
@@ -385,8 +384,13 @@ just a whole or floating point number (i.e. 26, 26.1 or 26.13).
 
 =item partial_auth
 
-Set true to accept a partial authorization.  If this flag is not set, a partial
-authorization will be immediately reversed or voided.
+If you are prepared to handle partial authorizations
+(see L<partial_auth_amount()|/"partial_auth_amount()">
+ in L<TRANSACTION RESULT FIELDS|/"TRANSACTION RESULT FIELDS">),
+pass a true value in this field to enable them.
+
+If this flag is not set, a partial authorization will be immediately reversed
+or voided.
 
 =item description
 
@@ -661,6 +665,15 @@ Returns true if the transaction was approved by the gateway, false if
 it was submitted but not approved, or undef if it has not been 
 submitted yet.
 
+=head2 partial_auth_amount()
+
+If this transaction was a partial authorization (i.e. successful, but less than
+the requested amount was processed), then the amount processed is returned in
+this field.
+
+(When is_success is true but this field is empty or 0, that indicates a normal
+full authorization for the entire requested amount.)
+
 =head2 error_message()
 
 If the transaction has been submitted but was not accepted, this
@@ -678,11 +691,6 @@ other errors).
 Note that not all processor modules support this, and that if supported,
 it may not be set for all declines.
 
-=head2 partial_auth_amount()
-
-Amount of the partial authorization, if the processor supports them and the
-partial_auth flag was passed to indicate they should be processed.
-
 =head2 authorization()
 
 If the transaction has been submitted and accepted, this function will