From: plobbes Date: Sat, 10 Mar 2007 21:53:18 +0000 (+0000) Subject: - added missing =over 4 and =back and other minor formatting X-Git-Tag: BUSINESS_ONLINEPAYMENT_3_00_06~6 X-Git-Url: http://git.freeside.biz/gitweb/?p=Business-OnlinePayment.git;a=commitdiff_plain;h=4a0fcddf3100ea7e72007bee2cf3b758f7f4a32f - added missing =over 4 and =back and other minor formatting --- diff --git a/OnlinePayment.pm b/OnlinePayment.pm index 1d579f2..f91ef1e 100644 --- a/OnlinePayment.pm +++ b/OnlinePayment.pm @@ -262,14 +262,18 @@ Your login name to use for authentication to the online processor. Your password to use for authentication to the online processor. +=back + =head3 GENERAL TRANSACTION FIELDS +=over 4 + =item * type -Transaction type, supported types are: CC (credit card), ECHECK (electronic -check) and LEC (phone bill billing). Deprecated types are: Visa, MasterCard, -American Express, Discover, Check (not all processors support all these -transaction types). +Transaction type, supported types are: CC (credit card), ECHECK +(electronic check) and LEC (phone bill billing). Deprecated types +are: Visa, MasterCard, American Express, Discover, Check (not all +processors support all these transaction types). =item * action @@ -291,8 +295,12 @@ and the like, just a floating point number. An invoice number, for your use and not normally required, many processors require this field to be a numeric only field. +=back + =head3 CUSTOMER INFO FIELDS +=over 4 + =item * customer_id A customer identifier, again not normally required. @@ -318,8 +326,8 @@ are requiring AVS Verification). =item * city -The customer's city (your processor may not require this unless you are -requiring AVS Verification). +The customer's city (your processor may not require this unless you +are requiring AVS Verification). =item * state @@ -328,8 +336,8 @@ are requiring AVS Verification). =item * zip -The customer's zip code (your processor may not require this unless you -are requiring AVS Verification). +The customer's zip code (your processor may not require this unless +you are requiring AVS Verification). =item * country @@ -351,9 +359,9 @@ Customer's country. =item * ship_country -These shipping address fields may be accepted by your processor. Refer to the -description for the corresponding non-ship field for general information on -each field. +These shipping address fields may be accepted by your processor. +Refer to the description for the corresponding non-ship field for +general information on each field. =item * phone @@ -367,8 +375,12 @@ Customer's fax number. Customer's email address. +=back + =head3 CREDIT CARD FIELDS +=over 4 + =item * card_number Credit card number (obviously not required for non-credit card @@ -376,8 +388,8 @@ transactions). =item * cvv2 -CVV2 number (also called CVC2 or CID) is a three- or four-digit security code -used to reduce credit card fraud. +CVV2 number (also called CVC2 or CID) is a three- or four-digit +security code used to reduce credit card fraud. =item * expiration @@ -388,15 +400,21 @@ transactions). Recurring billing flag +=back + =head3 ELECTRONIC CHECK FIELDS +=over 4 + =item * account_number -Bank account number for electronic checks or electronic funds transfer. +Bank account number for electronic checks or electronic funds +transfer. =item * routing_code -Bank's routing code for electronic checks or electronic funds transfer. +Bank's routing code for electronic checks or electronic funds +transfer. =item * account_type @@ -404,7 +422,8 @@ Account type for electronic checks or electronic funds transfer. =item * account_name -Account holder's name for electronic checks or electronic funds transfer. +Account holder's name for electronic checks or electronic funds +transfer. =item * bank_name @@ -420,13 +439,13 @@ Customer organization type. =item * customer_ssn -Customer's social security number. Typically only required for electronic -checks or electronic funds transfer. +Customer's social security number. Typically only required for +electronic checks or electronic funds transfer. =item * license_num -Customer's driver's license number. Typically only required for electronic -checks or electronic funds transfer. +Customer's driver's license number. Typically only required for +electronic checks or electronic funds transfer. =item * license_dob @@ -446,11 +465,11 @@ it failed (or undef if it has not been submitted yet). =head2 failure_status(); -If the transaction failed, it can optionally return a specific -failure status (normalized, not gateway-specific). Currently defined -statuses are: "expired", "nsf" (non-sufficient funds), "stolen", -"pickup", "blacklisted" and "declined" (card/transaction declines -only, not other errors). +If the transaction failed, it can optionally return a specific failure +status (normalized, not gateway-specific). Currently defined statuses +are: "expired", "nsf" (non-sufficient funds), "stolen", "pickup", +"blacklisted" and "declined" (card/transaction declines only, not +other errors). Note that (as of Aug 2006) this is only supported by some of the newest processor modules, and that, even if supported, a failure @@ -479,7 +498,7 @@ verification (if the processor supports it). =head2 transaction_type(); -Retrieve the transaction type (the 'type' argument to contents();). +Retrieve the transaction type (the 'type' argument to contents()). Generally only used internally, but provided in case it is useful. =head2 error_message(); @@ -500,11 +519,13 @@ YOUR OWN RISK). =head2 port(); -Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK). +Retrieve or change the processor submission port (CHANGE AT YOUR OWN +RISK). =head2 path(); -Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK). +Retrieve or change the processor submission path (CHANGE AT YOUR OWN +RISK). =head1 AUTHORS