|login||Your login name to use for authentication to the online processor.|
|password||Your password to use for authentication to the online processor.|
|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 transaction types.|
What action being taken by this transaction. Currently available are:
|amount||The amount of the transaction. No dollar signs or currency identifiers, just a whole or floating point number (i.e. 26, 26.1 or 26.13).|
If you are prepared to handle partial authorizations
in 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.
|description||A description of the transaction (used by some processors to send information to the client, normally not a required field).|
|invoice_number||An invoice number, for your use and not normally required, many processors require this field to be a numeric only field.|
|po_number||Purchase order number (normally not required).|
|tax||Tax amount (portion of amount field, not added to it).|
|freight||Freight amount (portion of amount field, not added to it).|
|duty||Duty amount (portion of amount field, not added to it).|
|tax_exempt||Tax exempt flag (i.e. TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0).|
|currency||Currency, specified as an ISO 4217 three-letter code, such as USD, CAD, EUR, AUD, DKK, GBP, JPY, NZD, etc.|
|customer_id||A customer identifier, again not normally required.|
|name||The customers name, your processor may not require this.|
|last_name||The customers first and last name as separate fields.|
|company||The customers company name, not normally required.|
|address||The customers address (your processor may not require this unless you are requiring AVS Verification).|
|city||The customers city (your processor may not require this unless you are requiring AVS Verification).|
|state||The customers state (your processor may not require this unless you are requiring AVS Verification).|
|zip||The customers zip code (your processor may not require this unless you are requiring AVS Verification).|
|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.|
|phone||Customers phone number.|
|fax||Customers fax number.|
|Customers email address.|
|customer_ip||IP Address from which the transaction originated.|
|card_number||Credit card number.|
|expiration||Credit card expiration, MM/YY.|
|cvv2||CVV2 number (also called CVC2 or CID) is a three- or four-digit security code used to reduce credit card fraud.|
|card_token||If supported by your gateway, you can pass a card_token instead of a card_number and expiration.|
|track1||Track 1 on the magnetic stripe (Card present only)|
|track2||Track 2 on the magnetic stripe (Card present only)|
|recurring_billing||Recurring billing flag|
|account_number||Bank account number|
|routing_code||Banks routing code|
|account_type||Account type. Can be (case-insensitive): <B>Personal CheckingB>, <B>Personal SavingsB>, <B>Business CheckingB> or <B>Business SavingsB>.|
|account_name||Account holders name.|
|customer_org||Customer organization type.|
|customer_ssn||Customers social security number.|
|license_num||Customers drivers license number.|
|license_dob||Customers date of birth.|
|interval||Interval expresses the amount of time between billings: digits, whitespace and units (currently days or months in either singular or plural form).|
|start||The date of the first transaction (used for processors which allow delayed start) expressed as YYYY-MM-DD.|
|periods||The number of cycles of interval length for which billing should occur (inclusive of trial periods if the processor supports recurring billing at more than one rate)|
submit()Submit the transaction to the processor for completion.
is_success()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.
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.)
error_message()If the transaction has been submitted but was not accepted, this function will return the provided error message (if any) that the processor returned.
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).
Note that not all processor modules support this, and that if supported, it may not be set for all declines.
authorization()If the transaction has been submitted and accepted, this function will provide you with the authorization code that the processor returned. Store this if you would like to run inquiries or refunds on the transaction later.
order_number()The unique order number for the transaction generated by the gateway. Store this if you would like to run inquiries or refunds on the transaction later.
card_token()If supported by your gateway, a card_token can be used in a subsequent transaction to refer to a card number.
fraud_score()Retrieve or change the fraud score from any Business::FraudDetect plugin
fraud_transaction_id()Retrieve or change the transaction id from any Business::FraudDetect plugin
response_page()These three fields are set by some processors (especially those which use HTTPS) when the transaction fails at the communication level rather than as a transaction.
response_code is the HTTP response code and message, i.e. 500 Internal Server Error.
response_headers is a hash reference of the response headers
response_page is the raw content.
result_code()Returns the precise result code that the processor returned, these are normally one letter codes that dont mean much unless you understand the protocol they speak, you probably dont need this, but its there just in case.
transaction_type()Retrieve the transaction type (the type argument to contents()). Generally only used internally, but provided in case it is useful.
server()Retrieve or change the processor submission server address (CHANGE AT YOUR OWN RISK).
port()Retrieve or change the processor submission port (CHANGE AT YOUR OWN RISK).
path()Retrieve or change the processor submission path (CHANGE AT YOUR OWN RISK).
build_subs( CW@sub_names )Build setter/getter subroutines for new return values.
get_fields( CW@fields )Get the named fields if they are defined.
remap_fields( CW%map )Remap field content (and stuff it back into content).
required_fields( CW@fields )Croaks if any of the required fields are not present.
silly_bool( CW$value )Returns 0 if the value starts with y, Y, t or T. Returns 1 if the value starts with n, N, f or F. Otherwise returns the value itself.
Use this for handling boolean content like tax_exempt.
Jason Kohles, firstname.lastname@example.org
Ivan Kohler <email@example.com>
Phil Lobbes <phil at perkpartners dot com>
Copyright (c) 1999-2004 Jason Kohles Copyright (c) 2004 Ivan Kohler Copyright (c) 2007-2015 Freeside Internet Services, Inc.
All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Please direct current development questions, patches, etc. to the mailing list: http://420.am/cgi-bin/mailman/listinfo/bop-devel/
The code is available from our public git repository:
git clone git://git.freeside.biz/Business-OnlinePayment.git
Or on the web:
http://freeside.biz/gitweb/?p=Business-OnlinePayment.git Or: http://freeside.biz/gitlist/Business-OnlinePayment.git
Many (but by no means all!) processor plugins are also available in the same repository, see:
THIS SOFTWARE IS PROVIDED AS IS AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
For verification of credit card checksums, see Business::CreditCard.
|perl v5.20.3||ONLINEPAYMENT (3)||2015-12-03|