You are here

Home » API reference » Commerce Worldpay 7

README.txt in Commerce Worldpay 7

Same filename in this branch
  1. 7 README.txt
  2. 7 worldpay page example/README.txt
Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Theme development
 * Known issues
 * Support
 * Sponsorship
 * Acknowledgements/Credits


INTRODUCTION
------------

This module implements support for WorldPay's Business Gateway payment gateway
service with Drupal Commerce as a payment module.

Please note this is for WorldPays HTTP service. Not its higher tier XML Direct
service. You will need to use the commerce_worldpay_xml module for that service.


INSTALLATION
------------

 1. Copy the 'commerce_worldpay_bg' folder into the modules directory
    usually: '/sites/all/modules/'.

 2. In your Drupal site, enable the module under Administration -> Modules
    The module will be in the group Commerce - Payment.

 3. Go to Store > Configuration > Payment Methods.

 4. Verify that "Payment via WorldPay" is an enabled payment. If not then click
    "enable" in its row.

 5. Click the "edit" link for "Payment via WorldPay".

 6. Under "Actions", "Enable payment method: Payment via WorldPay", click
    "edit".

 7. Follow the instruction on the page to complete the configuration of the
    module with your WorldPay installation.


THEME DEVELOPMENT
-----------------
WorldPay allows the customisation of the presentation to its payment pages. Part
of this is handled entirely on WorldPay's end by uploading assets to the correct
area of the merchant's WorldPay administration page. Another part is generated
by Drupal and pulled in by WorldPay for presentation on their end. The later
part is editable using Drupal's standard theming system using templates. The
two parts are found within:
module_dir/
          theme/ - Contains the Drupal template definitions.
          worldpay page example/ - Contains example's of files to be used in 
                                   WorldPay's payment pages.
Please see the README.txt file in the "worldpay page example/" folder for more
information.

NOTE: The odd tags like <WPDISPLAY> are special WorldPay tag's that WorldPay
will parse when loading the pages. Please review WorldPay's own documentation
for further information on these.

The module implements a special debugging page at:
commerce_worldpay/bg/response/debug_me
This will present a simulation of the response page generated for WorldPay.

KNOWN ISSUES
------------

 * This module will not work reliably at the moment if the order
   field commerce_customer_billing is missing or if that field (profile) is
   missing the field commerce_customer_address.
   See http://drupal.org/node/2001424.
 * The order object must have the order::mail property set before the payment
   transaction is triggered. If you are using Drupal Commerce's account
   information pane then this is already done for you. But if you are
   gathering account details using a custom method, then you must ensure you
   correctly populate the order object used in checkout.
   See http://drupal.org/node/2001424
 * The "Add payment" tool on the order UI Payment page will not work if it uses
   this module to make a transaction. I'm not sure if this can be made to work
   with this service. See http://drupal.org/node/2001442.

TODO
----
* Set appropriate Commerce Transaction status for SecureCode ('authentication').
  See http://drupal.org/node/2001452.
* Set appropriate Commerce Transaction status for AVS ('AVS').
  See http://drupal.org/node/2001454.
* Finish Bartik WorldPay theme (images etc.): http://drupal.org/node/2001458
* Make the module function fine without an addressfield or billing profile.
  See http://drupal.org/node/2001424

SUPPORT
-------

If you encounter any issues, please file a support request
at http://drupal.org/project/issues/commerce_worldpay


SPONSORSHIP
-----------

This module was originally developed for Zixiao (http://www.zixiao.co.uk).

The module is maintained by MD Systems (http://www.md-systems.ch/)

ACKNOWLEDGEMENTS/CREDITS
------------------------

Much of the code here got a running start thanks to the Commerce PayPal and Sage
payment modules so thank you to the authors ikos and rszrama. Also thanks to the
Ubercart uc_worldpay author Hans Idink and psynaptic as that module also gave me
a running start on working with WorldPay's API.

AUTHORS
-------
Adam Lyall aka MagicMyth <magicmyth@magicmyth.com>

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Installation

  6.  * Theme development

  7.  * Known issues

  8.  * Support

  9.  * Sponsorship

  10.  * Acknowledgements/Credits

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. This module implements support for WorldPay's Business Gateway payment gateway

  17. service with Drupal Commerce as a payment module.

  18. 

  19. Please note this is for WorldPays HTTP service. Not its higher tier XML Direct

  20. service. You will need to use the commerce_worldpay_xml module for that service.

  21. 

  22. 

  23. INSTALLATION

  24. ------------

  25. 

  26.  1. Copy the 'commerce_worldpay_bg' folder into the modules directory

  27.     usually: '/sites/all/modules/'.

  28. 

  29.  2. In your Drupal site, enable the module under Administration -> Modules

  30.     The module will be in the group Commerce - Payment.

  31. 

  32.  3. Go to Store > Configuration > Payment Methods.

  33. 

  34.  4. Verify that "Payment via WorldPay" is an enabled payment. If not then click

  35.     "enable" in its row.

  36. 

  37.  5. Click the "edit" link for "Payment via WorldPay".

  38. 

  39.  6. Under "Actions", "Enable payment method: Payment via WorldPay", click

  40.     "edit".

  41. 

  42.  7. Follow the instruction on the page to complete the configuration of the

  43.     module with your WorldPay installation.

  44. 

  45. 

  46. THEME DEVELOPMENT

  47. -----------------

  48. WorldPay allows the customisation of the presentation to its payment pages. Part

  49. of this is handled entirely on WorldPay's end by uploading assets to the correct

  50. area of the merchant's WorldPay administration page. Another part is generated

  51. by Drupal and pulled in by WorldPay for presentation on their end. The later

  52. part is editable using Drupal's standard theming system using templates. The

  53. two parts are found within:

  54. module_dir/

  55.           theme/ - Contains the Drupal template definitions.

  56.           worldpay page example/ - Contains example's of files to be used in 

  57.                                    WorldPay's payment pages.

  58. Please see the README.txt file in the "worldpay page example/" folder for more

  59. information.

  60. 

  61. NOTE: The odd tags like  are special WorldPay tag's that WorldPay

  62. will parse when loading the pages. Please review WorldPay's own documentation

  63. for further information on these.

  64. 

  65. The module implements a special debugging page at:

  66. commerce_worldpay/bg/response/debug_me

  67. This will present a simulation of the response page generated for WorldPay.

  68. 

  69. KNOWN ISSUES

  70. ------------

  71. 

  72.  * This module will not work reliably at the moment if the order

  73.    field commerce_customer_billing is missing or if that field (profile) is

  74.    missing the field commerce_customer_address.

  75.    See http://drupal.org/node/2001424.

  76.  * The order object must have the order::mail property set before the payment

  77.    transaction is triggered. If you are using Drupal Commerce's account

  78.    information pane then this is already done for you. But if you are

  79.    gathering account details using a custom method, then you must ensure you

  80.    correctly populate the order object used in checkout.

  81.    See http://drupal.org/node/2001424

  82.  * The "Add payment" tool on the order UI Payment page will not work if it uses

  83.    this module to make a transaction. I'm not sure if this can be made to work

  84.    with this service. See http://drupal.org/node/2001442.

  85. 

  86. TODO

  87. ----

  88. * Set appropriate Commerce Transaction status for SecureCode ('authentication').

  89.   See http://drupal.org/node/2001452.

  90. * Set appropriate Commerce Transaction status for AVS ('AVS').

  91.   See http://drupal.org/node/2001454.

  92. * Finish Bartik WorldPay theme (images etc.): http://drupal.org/node/2001458

  93. * Make the module function fine without an addressfield or billing profile.

  94.   See http://drupal.org/node/2001424

  95. 

  96. SUPPORT

  97. -------

  98. 

  99. If you encounter any issues, please file a support request

  100. at http://drupal.org/project/issues/commerce_worldpay

  101. 

  102. 

  103. SPONSORSHIP

  104. -----------

  105. 

  106. This module was originally developed for Zixiao (http://www.zixiao.co.uk).

  107. 

  108. The module is maintained by MD Systems (http://www.md-systems.ch/)

  109. 

  110. ACKNOWLEDGEMENTS/CREDITS

  111. ------------------------

  112. 

  113. Much of the code here got a running start thanks to the Commerce PayPal and Sage

  114. payment modules so thank you to the authors ikos and rszrama. Also thanks to the

  115. Ubercart uc_worldpay author Hans Idink and psynaptic as that module also gave me

  116. a running start on working with WorldPay's API.

  117. 

  118. AUTHORS

  119. -------

  120. Adam Lyall aka MagicMyth