Sage Pay

Direct v3.1
for osCommerce Online Merchant v2.3

Sage Pay Direct is essentially a white-label payment solution giving you complete control over the way you process payments. Collect the card details through your own secure servers and securely pass them across to Sage Pay for authorisation and storage.

  • Shoppers stay on your site
  • Design, manage and host your own payment pages
  • Develop your own transaction reporting
  • Build your own automated transaction functions
  • Fully integrate with your backend systems (ie call centre software, CRM solutions, etc)
  • You will need to get your own PCI DSS certification and SSL certificates

Apply for a Sage Pay Account

Sage Pay Direct is bundled with osCommerce Online Merchant and is also available as a separate Add-On package existing store owners can use to upgrade to.

The Sage Pay Direct payment module supports the following features:

  • Securely stored payment cards (Tokens)
  • PayPal payments
  • SSL Certificate verified transactions

This document can be found online at:

https://library.oscommerce.com/Package&en&sage_pay&oscom23&direct

Features

Securely Stored Payment Cards (Tokens)

Stored tokens allows customers to securely save their card payment information during their purchase and to reference the stored card in their next purchase without having to re-type their card information again. The card payment information is securely stored at Sage Pay's servers and is referenced with a unique token code.

Requirements

Stored tokens requires the following:

  • Sage Pay Cards Management Page content module; it is important to enable the Sage Pay Cards Management Page content module to allow customers to manage their stored cards in their account area. The content module can be found on the Administration Tool -> Modules -> Content -> Install Module page.
  • Content Modules; as Sage Pay Cards Management Page is a content module, it requires the Content Modules implementation introduced in osCommerce Online Merchant v2.3.4. Please refer to its release notes to add the implementation into your existing store.

PayPal Payments

PayPal can be provided as a card payment method option. This requires PayPal to be added as a supported payment method to your Sage Pay account and your PayPal seller account to be linked to your Sage Pay account.

Please refer to Linking PayPal to Your Account for instructions on how to link PayPal to your account.

SSL Certificate Verified Transactions

All secured API transaction calls sent to Sage Pay are performed by verifying Sage Pay's SSL certificates to guarantee the identity of Sage Pay. This is performed by using the following public keys in order if they are available:

  • ext/modules/payment/sage_pay/sagepay.com.crt
  • includes/cacert.pem (public key bundle)
  • the web server configured public key bundle

A test connection link is available on the payment module configuration page which can be used to test if API transaction calls to Sage Pay can be verified from your web server. If the test connection fails, please contact your hosting provider as they may need to update your web server configuration. The SSL certificate verification can also be disabled on the payment module configuration page however it is highly discouraged to disable.

Configuration Settings

Parameter Description Default
Enable Sage Pay Direct Module Setting this parameter to True makes the payment method available to customers during the checkout procedure. True
Vendor Login Name The vendor login name used to connect to the transaction gateway with.
Verify With CVC Setting this parameter to True verifies the billing address with the Credit Card Verification Checknumber (CVC). True
Create Tokens Allows customers to store their payment cards securely at Sage Pay and reference the cards for future payments via tokens. False
Transaction Method The following transaction methods are available to process transactions with:
Authenticate
The Authenticate transaction method only verifies the card and card holder using the 3D-Secure mechanism provided by the card-schemes and card issuing banks. Authorisations and Settlements of transactions are performed manually on the My Sage Pay Admin interface.
Deferred
The Deferred transaction method verifies and authorises the transaction and is captured manually on the Sage Pay Admin Interface.
Payment
The Payment transaction method verifies, authorises, and transfers the funds to your Merchant account via batch settlement.
 Authenticate
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. Sage Pay [Transactions]
Payment Zone If set, this payment method will only be available to orders made within the defined zone.
Transaction Server The following transaction servers are available to process transactions through:
Live
The Live server is used in production environments to process and receive payments from customers.
Test
The Test server is only used to test transactions on the Production server. No transactions are processed and no payments are made when transactions are being tested.
 Live
Verify SSL Certificate Verify Sage Pay's identity when API communication calls are sent. True
Proxy Server Send API communication calls through this proxy server.
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.
Accept Visa Setting this parameter to True allows Visa payments to be accepted. True
Accept Mastercard Setting this parameter to True allows Mastercard payments to be accepted. True
Accept Mastercard Debit Setting this parameter to True allows Mastercard Debit payments to be accepted. True
Accept Visa Delta/Debit Setting this parameter to True allows Visa Delta/Debit payments to be accepted True
Accept Maestro Setting this parameter to True allows Maestro payments to be accepted. True
Accept Visa Electron UK Debit Setting this parameter to True allows Visa Electron UK Debit payments to be accepted. True
Accept American Express Setting this parameter to True allows American Express payments to be accepted True
Accept Diners Club Setting this parameter to True allows Diners Club payments to be accepted. True
Accept Japan Credit Bureau Setting this parameter to True allows Japan Credit Bureau payments to be accepted. True
Accept Laser Card Setting this parameter to True allows Laser Card payments to be accepted. True
Accept PayPal Setting this parameter to True allows PayPal payments to be accepted. False

Add-On Package

The separate Sage Pay Direct Add-On package is available at:

http://addons.oscommerce.com/info/6985

Online Demonstration

An online demonstration is available at:

http://demo.oscommerce.com

For the online demonstration, Sage Pay Direct has been configured with Sage Pay'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/content/account/sage_pay/cards.php
  • ext/modules/payment/sage_pay/checkout.php
  • ext/modules/payment/sage_pay/direct_3dauth.php
  • ext/modules/payment/sage_pay/errors.php
  • ext/modules/payment/sage_pay/redirect.php
  • includes/languages/english/modules/content/account/cm_account_sage_pay_cards.php
  • includes/languages/english/modules/payment/sage_pay_direct.php
  • includes/modules/content/account/cm_account_sage_pay_cards.php
  • includes/modules/payment/sage_pay_direct.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/content/account/cm_account_sage_pay_cards.php
  • includes/languages/LANGUAGE/modules/payment/sage_pay_direct.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

v3.1 09-Jun-2014
v2.2 compatibility updates (jQuery is now injected into the page when it has not been loaded).
v3.0 01-Jun-2014
Support PayPal payments.
Introduce Sage Pay Cards Management Content Module for the My Account page (requires osCommerce Online Merchant v2.3.4).
Automatically select payment module if customer has stored card tokens.
v2.0 26-Jul-2013
Use API 3.00.
Support stored card tokens.
Show month numbers instead of names for card expiry date.
Dynamically show card start and issue number fields depending on card selected.
Removed SOLO; Added LASER and MCDEBIT as allowed payment cards.
Include transaction information in a private order status level.
Add Test API Server Connection link in module configuration page.
Verify SSL connections with public key certificate.
v1.1 01-Sep-2009
Fixed Live/Production Transaction Server parameter value to "Live".
v1.0 28-Aug-2009
Initial Release