Hosted Payment Pages v2.2
for osCommerce Online Merchant v2.3
WorldPay Hosted Payment Pages is bundled with osCommerce Online Merchant and is also available as a separate Add-On package existing store owners can use to upgrade to.
This document can be found online at:
https://library.oscommerce.com/Package&en&worldpay&oscom23&hosted
Configuration Settings
Module Configuration
| Parameter | Description | Default |
|---|---|---|
| Enable WorldPay Hosted Payment Pages | Setting this parameter to True makes the payment method available to customers during the checkout procedure. | True |
| Installation ID | The Installation ID of the WorldPay account to use for transactions. | |
| Callback Password |
The password WorldPay sends to the callback processing script. This must be the same value as Payment Response password that is set on the WorldPay Merchant Interface. |
|
| MD5 Password |
The MD5 password to verify transactions with. This must be the same value as MD5 secret for transactions that is set on the WorldPay Merchant Interface. |
|
| Transaction Method |
The following transaction methods are available to process transactions with:
|
Capture |
| Set Preparing Order Status |
The customers order is saved in the database on the checkout confirmation page before the customer is forwarded to WorldPay to finalize the payment transaction. The order is saved in the database with this defined order status. The order status is updated again when the customer finalizes the payment transaction at WorldPay and returns to the store with the link provided by WorldPay. The order status is also updated when the Callback from WorldPay is received. If the customer does not finalize the payment transaction at WorldPay, the order remains in the database with this order status and can be removed after a period of time. |
Preparing [WorldPay] |
| Set Order Status | The orders status will be updated to this value when a successful transaction has been made. | Default Order Status |
| Transaction Order Status | Transactions are logged in this private order status level. | WorldPay [Transactions] |
| Payment Zone | If set, this payment method will only be available to orders made within the defined zone. | |
| Test Mode | Setting this parameter to True treats each transaction as a test transaction and does not process any funds. | False |
| Debug E-Mail Address | Send invalid transaction parameters to this e-mail address. | |
| Sort Order | The position to show the payment method on the checkout payment page against other available payment methods. |
WorldPay Merchant Interface
The following settings must be reviewed and set at the WorldPay Merchant Interface.
| Setting | Description |
|---|---|
| Payment Response URL |
This must be set to the following value: |
| Payment Response enabled? | This must be enabled. |
| Enable the Shopper Response | This must be enabled. |
| Payment Response password | This must be sent and must match the Callback Password module configuration value. |
| MD5 secret for transactions | This must be sent and must match the MD5 Password module configuration value. |
Add-On Package
The separate WorldPay Hosted Payment Pages Add-On package is available at:
http://addons.oscommerce.com/info/5665
Online Demonstration
An online demonstration is available at:
For the online demonstration, WorldPay Hosted Payment Pages has been configured with WorldPay's test server environment and requires a test payment card to purchase an order.
Manual Installation (as an Add-On)
After extracting the Add-On package, copy the files located in the catalog directory to your osCommerce installation directory on the server. The files must be copied in the correct directory structure as extracted from the Add-On package.
The file listing is as follows:
- ext/modules/payment/rbsworldpay/hosted_callback.php
- includes/languages/english/modules/payment/rbsworldpay_hosted.php
- includes/modules/payment/rbsworldpay_hosted.php
The standard language definitions in English are provided in the Add-On package. For additional languages, copy the English language definition file to the appropriate language directory and open the file with a text editor to edit the language definitions. The location of the language definition file must be in:
- includes/languages/LANGUAGE/modules/payment/rbsworldpay_hosted.php
When the files have been copied to their appropriate locations, the payment module will be available on the Administration Tool -> Modules -> Payment -> Install Module page where it can be installed, or on the Administration Tool -> Modules -> Payment page if the module was already previously installed.
If the module was already previously installed, it is important to visit the module configuration page to make sure new parameters are automatically installed in the database.
Changelog
- v2.2 20-Jul-2014
- Fix variable collision when processing an order.
- v2.1 09-Jun-2014
- v2.2 compatibility updates (jQuery is now injected into the page when it has not been loaded).
- v2.0 04-Jun-2014
- Perform more verifications on the callback transaction.
- Label public title with test tag when in testing mode.
- Allow debug transaction information to be sent in an e-mail for failed transactions
- Include transaction information in a private order status level.
- v1.0 12-Jan-2008
- Initial Release (WorldPay Select Junior)