Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 469 lines (450 sloc) 11.373 kB
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
1 <!-- ICS: Sonny Cook, Linkpoint: keyfile => secret -->
2
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
3 </para>
4 <section>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
5 <title>Gateway Configuration</title>
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
6 <para>The first step is to fulfil the prerequisites of the payment module
7 (listed in the individual module documentation below) and enable the module
8 in the global configuration file with the &conf-Require; directive:
9 <programlisting>
10 require Vend::Payment::NetBilling
11 </programlisting>
12 </para>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
13 <para>
14 If we are using only one gateway in a catalog, setting up
15 <literal>MV_PAYMENT</literal> variables is sufficient.
16
17 <informaltable>
18 <tgroup cols="3">
19 <thead>
20 <row>
21 <entry>Variable</entry>
22 <entry>Purpose</entry>
23 <entry>Notes</entry>
24 </row>
25 </thead>
26 <tbody>
27 <row>
28 <entry>&var-MV_PAYMENT_MODE;</entry>
9b4ab55 @racke rewritten MV_PAYMENT_MODE documentation and link to gateway glossary
racke authored
29 <entry>gateway mode name</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
30 <entry></entry>
31 </row>
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
32 <row>
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
33 <entry><literal>MV_PAYMENT_HOST</literal></entry>
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
34 <entry>gateway host name</entry>
35 <entry>optional (predefined in module)</entry>
36 </row>
37 <row>
38 <entry>&var-MV_PAYMENT_ID;</entry>
39 <entry>merchant identifier</entry>
40 <entry></entry>
41 </row>
42 <row>
43 <entry>&var-MV_PAYMENT_SECRET;</entry>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
44 <entry>secret part of credentials</entry>
45 <entry>password or certificate</entry>
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
46 </row>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
47 <row>
48 <entry><literal>MV_PAYMENT_REFERER</literal></entry>
49 <entry>referring URL</entry>
50 <entry></entry>
51 </row>
52 <row>
f5e1dbb @racke MV_PAYMENT_CURRENCY added
racke authored
53 <entry><literal>&var-MV_PAYMENT_CURRENCY;</literal></entry>
54 <entry>currency</entry>
2ce837d @racke notes added to MV_PAYMENT_CURRENCY
racke authored
55 <entry>three-letter currency code according to <ulink url="http://en.wikipedia.org/wiki/ISO_4217">ISO 4217</ulink></entry>
f5e1dbb @racke MV_PAYMENT_CURRENCY added
racke authored
56 </row>
57 <row>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
58 <entry><literal>MV_PAYMENT_TEST</literal></entry>
59 <entry>test mode</entry>
60 <entry></entry>
61 </row>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
62 </tbody>
63 </tgroup>
64 </informaltable>
65
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
66 An example configuration looks like:
67 <programlisting>
68 Variable MV_PAYMENT_MODE signio
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
69 Variable MV_PAYMENT_PARTNER verisign
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
70 Variable MV_PAYMENT_ID nevairbe
71 Variable MV_PAYMENT_SECRET foobar
72 </programlisting>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
73 </para>
74 </section>
75
52bdad7 @racke add more MV_PAYMENT variables
racke authored
76 <section id="gateway_multiple">
77 <title>Multiple Gateways</title>
78 <para>
79 With the &conf-Route; directive it is possible to specify payment gateways
80 for special purposes. The payment route should set all relevant payment
81 parameters for the gateway, otherwise the settings from the MV_PAYMENT_* may
82 leak into the route.
83 <programlisting>
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
84 Route signio partner verisign
52bdad7 @racke add more MV_PAYMENT variables
racke authored
85 Route signio id nevairbe
86 Route signio secret foobar
87 </programlisting>
88 </para>
89 </section>
90
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
91 <section id="gateway_transaction_types">
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
92 <title>Transaction Types</title>
93 <para>
0ecf8e6 @racke more modules, some transactions added
racke authored
94 The following payment gateway transactions are known by Interchange:
95
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
96 <informaltable>
0ecf8e6 @racke more modules, some transactions added
racke authored
97 <tgroup cols="2">
98 <thead>
99 <row>
100 <entry>Transaction</entry>
101 <entry>Description</entry>
102 </row>
103 </thead>
104 <tbody>
105 <row>
106 <entry>avs</entry>
107 <entry>Address verification (&glos-AVS;)</entry>
108 </row>
109 <row>
110 <entry>auth</entry>
7b0a434 @racke general transaction descriptions updated
racke authored
111 <entry>Payment authorization (Charge)</entry>
0ecf8e6 @racke more modules, some transactions added
racke authored
112 </row>
113 <row>
222b15f @racke more transaction, modules, etc.
racke authored
114 <entry>return</entry>
7b0a434 @racke general transaction descriptions updated
racke authored
115 <entry>Credit</entry>
222b15f @racke more transaction, modules, etc.
racke authored
116 </row>
117 <row>
118 <entry>reverse</entry>
119 <entry>Reverse former transaction</entry>
120 </row>
121 <row>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
122 <entry>sale</entry>
7b0a434 @racke general transaction descriptions updated
racke authored
123 <entry>Charge <emphasis>and</emphasis> capture</entry>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
124 </row>
125 <row>
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
126 <entry>settle</entry>
7b0a434 @racke general transaction descriptions updated
racke authored
127 <entry>Capture of an authorized charge</entry>
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
128 </row>
129 <row>
0ecf8e6 @racke more modules, some transactions added
racke authored
130 <entry>void</entry>
131 <entry>Cancel or refund payment</entry>
132 </row>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
133 <row>
134 <entry>abort</entry>
135 <entry>Abort pending capture.</entry>
136 </row>
0ecf8e6 @racke more modules, some transactions added
racke authored
137 </tbody>
138 </tgroup>
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
139 </informaltable>
140 </para>
141 </section>
0ecf8e6 @racke more modules, some transactions added
racke authored
142
9b4ab55 @racke rewritten MV_PAYMENT_MODE documentation and link to gateway glossary
racke authored
143 <section id="gateway_payment_modules">
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
144 <title>Payment Modules</title>
145 <para>
feb3f94 @racke started documentation on payment gateways
racke authored
146 Modules for the following payment gateways are included in the Interchange source
147 code:
148
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
149 <informaltable>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
150 <tgroup cols="4">
feb3f94 @racke started documentation on payment gateways
racke authored
151 <thead>
152 <row>
153 <entry>Module</entry>
154 <entry>Name</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
155 <entry>Mode</entry>
feb3f94 @racke started documentation on payment gateways
racke authored
156 <entry>Description</entry>
157 </row>
158 </thead>
159 <tbody>
160 <row>
161 <entry><literal>AuthorizeNet</literal></entry>
162 <entry>AuthorizeNet</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
163 <entry><literal>authorizenet</literal></entry>
feb3f94 @racke started documentation on payment gateways
racke authored
164 </row>
165 <row>
166 <entry><literal>BoA</literal></entry>
167 <entry>Bank of America</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
168 <entry><literal>boa</literal></entry>
feb3f94 @racke started documentation on payment gateways
racke authored
169 <entry></entry>
170 </row>
171 <row>
172 <entry><literal>BusinessOnlinePayment</literal></entry>
173 <entry>Business::OnlinePayment</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
174 <entry><literal>onlinepayment</literal></entry>
0ecf8e6 @racke more modules, some transactions added
racke authored
175 <entry>wrapper for <ulink url='http://search.cpan.org/perldoc?Business::OnlinePayment'>Business::OnlinePayment</ulink></entry>
feb3f94 @racke started documentation on payment gateways
racke authored
176 </row>
177 <row>
178 <entry><literal>Cybercash</literal></entry>
179 <entry>Cybercash</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
180 <entry><literal>cybercash</literal></entry>
feb3f94 @racke started documentation on payment gateways
racke authored
181 <entry></entry>
182 </row>
183 <row>
184 <entry><literal>ECHO</literal></entry>
185 <entry>Electronic Clearing House, Inc.</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
186 <entry><literal>echo</literal></entry>
feb3f94 @racke started documentation on payment gateways
racke authored
187 <entry></entry>
188 </row>
0ecf8e6 @racke more modules, some transactions added
racke authored
189 <row>
222b15f @racke more transaction, modules, etc.
racke authored
190 <entry><literal>EFSNet</literal></entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
191 <entry><ulink url='http://www.concordefsnet.com'>Concord
192 EFSNet</ulink></entry>
193 <entry><literal>echo</literal></entry>
194 <entry></entry>
195 </row>
196 <row>
197 <entry><literal>Ezic</literal></entry>
198 <entry>EziC</entry>
199 <entry><literal>ezic</literal></entry>
222b15f @racke more transaction, modules, etc.
racke authored
200 <entry></entry>
201 </row>
202 <row>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
203 <entry><literal>Getitcard</literal></entry>
204 <entry><ulink url='http://www.getitcard.com'>Getitcard</ulink></entry>
205 <entry><literal>getitcard</literal></entry>
206 <entry>Prepaid cards from Getitcard.</entry>
207 </row>
208 <row>
0ecf8e6 @racke more modules, some transactions added
racke authored
209 <entry><literal>ICS</literal></entry>
210 <entry>Cybersource ICS</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
211 <entry><literal>ICS</literal></entry>
212 <entry></entry>
213 </row>
214 <row>
215 <entry><literal>iTransact</literal></entry>
216 <entry>iTransact</entry>
217 <entry><literal>itransact</literal></entry>
218 </row>
219 <row>
220 <entry><literal>Linkpoint</literal></entry>
221 <entry>LinkPoint</entry>
222 <entry><literal>linkpoint</literal></entry>
223 <entry></entry>
224 </row>
225 <row>
226 <entry><literal>MCVE</literal></entry>
227 <entry>Mainstreet Credit Verification Engine</entry>
228 <entry><literal>mcve</literal></entry>
0ecf8e6 @racke more modules, some transactions added
racke authored
229 <entry></entry>
230 </row>
231 <row>
232 <entry><literal>NetBilling</literal></entry>
233 <entry>NetBilling</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
234 <entry><literal>netbilling</literal></entry>
235 <entry></entry>
236 </row>
237 <row>
238 <entry><literal>PRI</literal></entry>
239 <entry>Payment Resources International</entry>
240 <entry><literal>PRI</literal></entry>
241 <entry></entry>
242 </row>
243 <row>
244 <entry><literal>PSiGate</literal></entry>
245 <entry>PSiGate</entry>
246 <entry><literal>psigate</literal></entry>
0ecf8e6 @racke more modules, some transactions added
racke authored
247 <entry></entry>
248 </row>
249 <row>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
250 <entry><literal>Sage</literal></entry>
094d50a @racke Sage link and payment mode added
racke authored
251 <entry><ulink url='http://www.sagepayments.com/'>Sage Payment</ulink></entry>
252 <entry><literal>sage</literal></entry>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
253 </row>
254 <row>
0ecf8e6 @racke more modules, some transactions added
racke authored
255 <entry><literal>Signio</literal></entry>
222b15f @racke more transaction, modules, etc.
racke authored
256 <entry>Payflow Pro</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
257 <entry><literal>signio</literal></entry>
222b15f @racke more transaction, modules, etc.
racke authored
258 </row>
259 <row>
260 <entry><literal>Skipjack</literal></entry>
261 <entry>Skipjack</entry>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
262 <entry><literal>skipjack</literal></entry>
263 </row>
264 <row>
265 <entry><literal>TCLink</literal></entry>
266 <entry>TrustCommerce</entry>
267 <entry><literal>trustcommerce</literal></entry>
268 </row>
269 <row>
270 <entry><literal>TestPayment</literal></entry>
271 <entry>Payment Test</entry>
272 <entry><literal>testpayment</literal></entry>
381c1b6 @racke test payment: description and test numbers
racke authored
273 <entry>for test purposes</entry>
0ecf8e6 @racke more modules, some transactions added
racke authored
274 </row>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
275
feb3f94 @racke started documentation on payment gateways
racke authored
276 </tbody>
277 </tgroup>
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
278 </informaltable>
feb3f94 @racke started documentation on payment gateways
racke authored
279 </para>
4bb0c15 @racke use informaltable, use more sections, added settle transaction
racke authored
280 </section>
feb3f94 @racke started documentation on payment gateways
racke authored
281
282 <section>
283 <title>AuthorizeNet</title>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
284 <para>
285 The AuthorizeNet module implements the ADC Direct Response method for
286 AuthorizeNet version 3.
287 </para>
feb3f94 @racke started documentation on payment gateways
racke authored
288 <section>
289 <title>Prerequisites</title>
290 <para>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
291 Either Net::SSLeay or LWP::UserAgent and Crypt::SSLeay from CPAN.
feb3f94 @racke started documentation on payment gateways
racke authored
292 </para>
293 </section>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
294 <section>
295 <title>Parameters</title>
296 <para>Required parameters are id and secret.</para>
297 <section>
298 <title>id</title>
299 <para>
300 The AuthorizeNet account ID, received from AuthorizeNet after sign up.
301 </para>
302 </section>
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
303 <section>
304 <title>secret</title>
305 <para>
306 The AuthorizeNet account password, received from AuthorizeNet after sign up.
307 </para>
308 </section>
52bdad7 @racke add more MV_PAYMENT variables
racke authored
309 </section>
feb3f94 @racke started documentation on payment gateways
racke authored
310 </section>
311
222b15f @racke more transaction, modules, etc.
racke authored
312 <section>
313 <title>ECHO</title>
314 <section>
315 <title>Prerequisites</title>
316 <para>
317 OpenECHO module from <ulink url='http://www.openecho.com/'>http://www.openecho.com/</ulink>.
318 </para>
319 </section>
320 </section>
321
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
322 <section>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
323 <title>Getitcard</title>
324 <para>
325 The Getitcard payment module is used for purchases with prepaid cards issued
326 by Getitcard&reg;
327 (<ulink url='http://www.getitcard.com/'>http://www.getitcard.com/</ulink>).
328 </para>
329 <section>
330 <title>Prerequisites</title>
331 <para>
332 Either Net::SSLeay or LWP::UserAgent and Crypt::SSLeay from CPAN.
333 </para>
334 </section>
3b5c1a4 @racke parameter documentation for Getitcard/Sage started
racke authored
335 <section>
336 <title>Parameters</title>
337 <para>Required parameter is <literal>id</literal>.</para>
338 </section>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
339 </section>
340
341 <section>
342 <title>LinkPoint</title>
343 <para>
344 </para>
345 <section><title>Parameters</title>
346 <para>Required parameters are <literal>id</literal> and <literal>keyfile</literal>.
347 </para>
348 <section><title><literal>host</literal></title>
349 <para>
350 The domain name of the LinkPoint Secure Payment Gateway (LSPG). Default is
351 <literal>secure.linkpt.net</literal> for production and
352 <literal>staging.linkpt.net</literal> for testing.
353 </para>
354 </section>
355 <section><title><literal>id</literal></title>
356 <para>
357 Store number assigned to your merchant account.
358 </para>
359 </section>
360 <section><title><literal>keyfile</literal></title>
361 <para>
362 File name of the merchant security certificate. This file should contain the
363 RSA private key and the certificate, otherwise you get an error like
364 "Unable to open/parse client certificate file."
365 </para>
366 </section>
367 <section><title><literal>transaction</literal></title>
368 <para>
369 The type of transaction to be run. Valid values are:
370 </para>
371 <informaltable>
372 <tgroup cols="2">
373 <thead>
374 <row><entry>Interchange</entry><entry>Linkpoint</entry></row>
375 </thead>
376 <tbody>
377 <row><entry>auth</entry><entry>preauth</entry></row>
378 <row><entry>sale</entry><entry>sale</entry></row>
379 </tbody>
380 </tgroup>
381 </informaltable>
382 <para>
383 Default is <literal>sale</literal>.
384 </para>
385 </section>
386 </section>
387 </section>
388
389 <section>
b05604f @racke some payment variables added, example configuration, a selection of d…
racke authored
390 <title>Netbilling</title>
391 <para>
392 The Netbilling module implements the <ulink
393 url="http://netbilling.com/direct/direct2.html">Netbilling Direct Mode
394 2.1</ulink>.
395 </para>
396 <section><title>Prerequisites</title>
397 </section>
398 <section><title>Parameters</title>
399 <section><title><literal>host</literal></title>
400 <para>
401 The domain name of the NetBilling secure server. Defaults to
402 <literal>secure.netbilling.com</literal>.
403 </para>
404 </section>
405 <section><title><literal>id</literal></title>
406 <para>
407 This is your account and sitetag separated by a colon (ACCOUNT:SITETAG).
408 ACCOUNT is the number of your Netbilling merchant or agent account, as a
409 12-character string. Required for ALL transactions. SITETAG is the site
410 tag of your website configured in the Netbilling system. Required for
411 membership transactions, optional for others.
412 </para>
413 </section>
414 </section>
415 </section>
416
417 <section>
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
418 <title>Sage</title>
419 <section>
420 <title>Parameters</title>
421 <para>
3b5c1a4 @racke parameter documentation for Getitcard/Sage started
racke authored
422 Required parameters are <literal>id</literal> and <literal>secret</literal>.
92a7383 @racke new payment gateways Sage/Getitcard added
racke authored
423 </para>
424 </section>
425 </section>
426
427 <section>
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
428 <title>Signio</title>
429 <section>
430 <title>Parameters</title>
431 <para>
432 Required parameters are <literal>partner</literal>, <literal>id</literal>,
433 and <literal>secret</literal>.
434 </para>
435 </section>
436 </section>
437
438 <section>
f529886 @racke list of payment modules completed, added mode column to module table
racke authored
439 <title>TCLink</title>
440 <section>
441 <title>Prerequisites</title>
442 <para>
443 Net::TCLink module from <ulink
444 url='http://www.trustcommerce.com/tclink.html'>http://www.trustcommerce.com/tclink.html</ulink>
445 or <ulink url='http://search.cpan.org/perldoc?Net::TCLink'>CPAN</ulink>.
446 </para>
447 </section>
448 </section>
449
381c1b6 @racke test payment: description and test numbers
racke authored
450 <section>
451 <title>TestPayment</title>
452 <para>This module can be used for test purposes.</para>
453 <section>
454 <title>Card Numbers</title>
455 <para>
456 If the card number is <literal>4111111111111111</literal> then the
457 transaction will be approved.
458 </para>
459 <para>
460 If the card number is <literal>4111111111111129</literal> then the
461 transaction will be declined.
462 </para>
463 <para>
464 Any other card number will raise an error and the transaction will be declined.
465 </para>
466 </section>
467 </section>
468
c330dd6 @racke use MV_PAYMENT_HOST instead of MV_PAYMENT_SERVER
racke authored
469 <para>
Something went wrong with that request. Please try again.