Added processor_id functionality

[Business-BatchPayment.git] / BatchPayment / Processor.pm

diff --git a/BatchPayment/Processor.pm b/BatchPayment/Processor.pm
index a148c16..3cb88c6 100644 (file)
--- a/BatchPayment/Processor.pm
+++ b/BatchPayment/Processor.pm
@@ -97,14 +97,18 @@ Specifying only 'input' will direct 'output' to /dev/null, and vice versa.
 =item submit BATCH
 
 Send a batch of requests to the gateway.  BATCH must be a 
-L<Business::BatchPayment::Batch>.
+L<Business::BatchPayment::Batch>.  No defined return value,
+but processors may optionally set the 'processor_id' field
+on the input batch, which should then be stored and passed
+to receive.
 
 =item receive
 
 Download/otherwise acquire the available confirmed transactions from the 
 gateway, parse them, and return a list of L<Business::BatchPayment::Batch>
 objects.  The items in these batches will have, at minimum, the 'approved' 
-field and either the 'tid' or 'amount' field set.
+field and either the 'tid' or 'amount' field set.  Accepts an optional
+list of processor_id strings, if required by your processor.
 
 =item format_request BATCH