From 89a22e7c2a7dddeda325ded717efa751c65b4b5a Mon Sep 17 00:00:00 2001
From: Ivan Kohler <ivan@freeside.biz>
Date: Tue, 9 Aug 2016 05:53:13 -0700
Subject: [PATCH] doc: follow-up transaction fields

---
 Changes                     |  2 ++
 OnlinePayment.pm            | 20 +++++++++++++++++++-
 notes_for_module_writers_v3 | 19 +++++++++++++++++--
 3 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/Changes b/Changes
index 32e7195..a98e39b 100644
--- a/Changes
+++ b/Changes
@@ -2,6 +2,8 @@ Revision history for Perl extension Business::OnlinePayment.
 
 3.05    unreleased
         - Add txn_date to return fields (and build_subs)
+        - doc: Add Tokenize action (stand-alone tokenize without a transaction)
+        - doc: follow-up transaction fields
 
 3.04    Thu Dec  3 12:49:59 PST 2015
         - Partial authorizations
diff --git a/OnlinePayment.pm b/OnlinePayment.pm
index b4404fe..e5ea112 100644
--- a/OnlinePayment.pm
+++ b/OnlinePayment.pm
@@ -364,6 +364,8 @@ What action being taken by this transaction. Currently available are:
 
 =item Credit
 
+=item Tokenize
+
 =item Recurring Authorization
 
 =item Modify Recurring Authorization
@@ -613,6 +615,21 @@ Customer's date of birth.
 
 =back
 
+=head3 FOLLOW-UP TRANSACTION FIELDS
+
+These fields are used in follow-up transactions related to an original
+transaction (Post Authorization, Reverse Authorization, Void, Credit).
+
+=over 4
+
+=item authorization
+
+=item order_number
+
+=item txn_date
+
+=back
+
 =head3 RECURRING BILLING FIELDS
 
 =over 4
@@ -712,7 +729,8 @@ transaction to refer to a card number.
 =head2 txn_date()
 
 Transaction date, as returned by the gateway.  Required by some gateways
-for follow-up transactions.
+for follow-up transactions.  Store this if you would like to run inquiries or
+refunds on the transaction later.
 
 =head2 fraud_score()
 
diff --git a/notes_for_module_writers_v3 b/notes_for_module_writers_v3
index 6b64805..fed359a 100644
--- a/notes_for_module_writers_v3
+++ b/notes_for_module_writers_v3
@@ -103,7 +103,7 @@ These are the module writer's notes for v3.  See the regular
 
   Gateways will return one or two values from Authorization Only and
   Normal Authorization transactions that must be submitted back with a
-  Post Authorization, Void, or Credit transaction.
+  Post Authorization, Reverse Authorization, Void, or Credit transaction.
 
   If the gateway returns one value, return this as "authorization"
 
@@ -113,6 +113,21 @@ These are the module writer's notes for v3.  See the regular
   is a unique tranaction id generated by the gateway.
 
 
+= txn_date (NEW IN 3.05) =
+
+  Some gateways return a transaction date from Authorization Only / Normal
+  Authorization transactions that must be submitted back for a follow-up
+  Post Authorization, Reverse Authorization, Void, or Credit transaction.
+
+  For the most compatibility with all gateways for follow-up transactions,
+  pass this as well as authorization and order number.  Note this field is
+  a recent addition, so always access it like this:
+
+    my $txn_date =   $bop_transaction_object->can('txn_date')
+                   ? $bop_transaction_object->txn_date
+                   : '';
+
+
 = Moo (NEWLY DOCUMENTED IN 3.04) =
 
   Feel free to write gateway modules which use Moo.  Please do not require
@@ -133,7 +148,7 @@ These are the module writer's notes for v3.  See the regular
   - Honor the transaction 'partial_auth' flag as follows:
     + If this transaction flag is unset, the application is not expecting to
       handle a partial authorzation.  So, either set the gateway flag disabling
-      partial authorizations, or (if your gatweay does not have such a
+      partial authorizations, or (if your gateway does not have such a
       setting), immediately void any partial authorization received and
       return is_success 0.
     + If this transaction flag is set, the application can handle a partial
-- 
2.11.0