diff options
author | Jonathan Prykop <jonathan@freeside.biz> | 2015-03-11 19:26:03 -0500 |
---|---|---|
committer | Jonathan Prykop <jonathan@freeside.biz> | 2015-03-11 19:26:03 -0500 |
commit | 771e64b732c69902be5552d53d4a7a1199d5fca3 (patch) | |
tree | e44a46a776fb0142f31ef5804d427d4b07154e32 | |
parent | 55ef5977a4319b9b79e265d99306a141a96eb250 (diff) |
documentation for FS::pay_batch::import_results, cuz I was tracing it anyway
-rw-r--r-- | FS/FS/pay_batch.pm | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/FS/FS/pay_batch.pm b/FS/FS/pay_batch.pm index fcf1a5a..f41b3e3 100644 --- a/FS/FS/pay_batch.pm +++ b/FS/FS/pay_batch.pm @@ -220,6 +220,36 @@ I<format> - an L<FS::pay_batch> module I<gateway> - an L<FS::payment_gateway> object for a batch gateway. This takes precedence over I<format>. +Supported format keys (defined in the specified FS::pay_batch module) are: + +I<filetype> - CSV, fixed, variable, XML + +I<fields> - list of field names for each row/line + +I<formatre> - regular expression for fixed filetype + +I<parse> - for variable filetype + +I<xmlkeys> - for XML filetype + +I<xmlrow> - for XML filetype + +I<begin_condition> - sub, ignore all lines before this returns true + +I<end_condition> - sub, stop processing lines when this returns true + +I<end_hook> - sub, runs immediately after end_condition returns true + +I<skip_condition> - sub, skip lines when this returns true + +I<hook> - sub, runs before approved/declined conditions are checked + +I<approved> - sub, returns true when approved + +I<declined> - sub, returns true when declined + +I<close_condition> - sub, decide whether or not to close the batch + =cut sub import_results { |