1 These are the module writer's notes for v3. See the regular
2 "notes_for_module_writers" file first.
5 - If your gateway is HTTPS-based, use (or convert to)
6 Business::OnlinePayment::HTTPS !!
7 Note: The correct thing for modern B:OP: gateway modules that need to
8 speak HTTPS to do is to use Business::OnlinePayment::HTTPS and depend on
9 "Net::HTTPS::Any" (since B:OP itself doesn't).
14 - If your processor module encounters a setup problem, communication
15 error or other problem that's prevents the card from even being
16 run, you should die (or croak) with a useful error message. Setting
17 is_success to 0 and returning normally should only be done when the
18 transaction *processing* was sucessful (or at least elicited some sort
19 of result from the gateway), but the transaction itself returned a
20 "normal" decline status of some sort.
22 - (NEW IN 3.00_04) You should set "failure_status" depending on the
23 specific failure result, if (and only if) the failure results from one
24 of the defined statuses:
27 - "nsf" (non-sufficient funds / credit limit)
31 - "inactive" (inactive card or not authorized for card-not-present) (?)
32 - "decline" (other card/transaction declines only, not other errors)
35 - (NEW IN 3.01) Introspection:
37 - Add an _info subroutine to your module that returns a hashref of
42 'info_compat' => '0.01', # always 0.01 for now,
43 # 0.02 will have requirements
44 'gateway_name' => 'Example Gateway',
45 'gateway_url' => 'http://www.example.com/',
46 'module_version' => $VERSION,
47 'supported_types' => [ qw( CC ECHECK ) ],
48 'token_support' => 0, #card storage/tokenization support
49 'test_transaction' => 0, #set true if ->test_transaction(1) works
50 'supported_actions' => [
51 'Normal Authorization',
60 # or a more complicated case:
64 'info_compat' => '0.01', # always 0.01 for now,
65 # 0.02 will have requirements
66 'gateway_name' => 'Example Gateway',
67 'gateway_url' => 'http://www.example.com/',
68 'module_version' => $VERSION,
69 'module_notes' => 'usage notes',
70 'supported_types' => [ qw( CC ECHECK ) ],
72 'test_transaction' => 1,
73 'supported_actions' => { 'CC' => [
74 'Normal Authorization',
79 'Recurring Authorization',
80 'Modify Recurring Authorization',
81 'Cancel Recurring Authorization',
84 'Normal Authorization',
89 'CC_void_requires_card' => 1,
90 'ECHECK_void_requires_account' => 1, #routing_code, account_number, name
95 - authorization and order_number (NEWLY DOCUMENTED IN 3.01):
97 Gateways will return one or two values from Authorization Only and
98 Normal Authorization transactions that must be submitted back with a
99 Post Authorization, Void, or Credit transaction.
101 If the gateway returns one value, return this as "authorization"
103 If the gateway returns two values, return one as "authorization" and the
104 other as "order_number". Typically "authorization" is the more low-level
105 value returned from the underlying processing network while "order_number"
106 is a unique tranaction id generated by the gateway.
109 - Moo (NEWLY DOCUMENTED IN 3.04)
111 Feel free to write gateway modules which use Moo. Please do not require
112 Moo newer than 0.091011 at this time (until 2018 or so).