Sage Pay
Sage Pay
Sage Pay
Chapters
osCommerce Online Merchant v2.3
Sage Pay Account Settings
Copyright
Copyright (c) 2008-2014 osCommerce. All rights reserved. Content may be
reproduced for personal use only.
Authors
Harald Ponce de Leon
osCommerce Online
Merchant v2.3
Pages
Sage Pay Form
Sage Pay Server
Sage Pay Direct
Form v2.0
for osCommerce Online Merchant v2.3
Sage Pay Form is the simplest integration method to start accepting payments online
and is recommended for websites hosted on a shared server plan.
No card data is collected, stored or transferred on your site
Get automated email notifications when transactions require your attention
Look and feel fully customisable
Automated confirmation emails are optionally sent to shoppers when a transaction
is processed
Let Sage Pay take care of hosting your payment pages and handling card data
Simplified PCI compliance requirements
Apply for a Sage Pay Account
Sage Pay Form 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 Form payment module supports the following features:
PayPal payments
This document can be found online at:
http://library.oscommerce.com/Package&en&sage_pay&oscom23&form
Features
PayPal Payments
PayPal payments can be accepted as a payment method through Sage Pay. 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.
Configuration Settings
Parameter
Description
Default
Enable Sage
Pay Form
True
Module
procedure.
Vendor
Login Name
Encryption
Password
Transaction
Method
Vendor
E-Mail
Notification
Authenticate
Parameter
Description
Default
Customer and
Vendor
No One
Do not send either customer or vendor e-mails.
Customer and Vendor
Send customer and vendor e-mails if addresses
are provided.
Vendor Only
Send vendor e-mail but NOT the customer
e-mail.
Customer
E-Mail
Message
Set Order
Default Order
Status
Status
Transaction
Order Status
Sage Pay
[Transactions]
Payment
Zone
Transaction
Server
Live
Parameter
Description
The Test server is only used to test transactions
with. No transactions are processed and no
payments are made when transactions are being
tested.
Debug
E-Mail
Address
Sort Order
Default
Add-On Package
The separate Sage Pay Form Add-On package is available at:
http://addons.oscommerce.com/info/6983
Online Demonstration
An online demonstration is available at:
http://demo.oscommerce.com
For the online demonstration, Sage Pay Form has been configured with Sage Pay's
test server environment and requires a test payment card to purchase an order.
Changelog
v2.0 01-Jun-2014
Use API 3.00.
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.2 04-Sep-2009
Added VendorEMail, SendEMail, and eMailMessage parameters.
v1.1 01-Sep-2009
Fixed Live/Production Transaction Server parameter value to "Live".
v1.0 28-Aug-2009
Initial Release
Server v2.0
for osCommerce Online Merchant v2.3
Sage Pay Server requires you to have your own server to communicate with our
payment systems and to store additional transaction information. You won't need to
handle card details but it is recommended that you get an SSL certificate. Shoppers
will be redirected to Sage Pay's payment pages during the checkout process.
Collect and store additional transaction information on your server
Develop your own transaction reporting
Build your own automated transaction functions
Card details are handled by Sage Pay
Simplified PCI compliance requirements
Apply for a Sage Pay Account
Sage Pay Server 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 Server payment module supports the following features:
PayPal payments
SSL Certificate verified transactions
This document can be found online at:
http://library.oscommerce.com/Package&en&sage_pay&oscom23&server
Features
PayPal Payments
PayPal payments can be accepted as a payment method through Sage Pay. 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.
Configuration Settings
Parameter
Description
Default
Enable Sage
Pay Server
True
Module
Vendor Login
Name
Profile
Payment
Page
Normal
Normal
Redirect the customer to the payment page
hosted at Sage Pay.
Low
Load the Sage Pay payment page through an
iframe in the checkout procedure.
Transaction
Method
Authenticate
Parameter
Description
Default
Set Order
Status
Default Order
Status
Transaction
Sage Pay
Order Status
status level.
[Transactions]
Payment
Zone
Transaction
Server
Live
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 with. No transactions are
processed and no payments are made when
transactions are being tested.
Verify SSL
Certificate
Proxy Server
Debug E-Mail
Address
Sort Order
True
Add-On Package
The separate Sage Pay Server Add-On package is available at:
http://addons.oscommerce.com/info/6984
Online Demonstration
An online demonstration is available at:
http://demo.oscommerce.com
For the online demonstration, Sage Pay Server has been configured with Sage Pay's
test server environment and requires a test payment card to purchase an order.
ext/modules/payment/sage_pay/redirect.php
ext/modules/payment/sage_pay/server.php
includes/languages/english/modules/payment/sage_pay_server.php
includes/modules/payment/sage_pay_server.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/sage_pay_server.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.0 01-Jun-2014
Use API 3.00.
Use a stateless NotificationURL to verify transactions.
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.
Add Test API Server Connection link in module configuration page.
Verify SSL connections with public key certificate.
v1.2 07-Sep-2012
Fixed generated URLs (tep_href_link() produces & in URLs which need to
be replaced with & in the payment module)
v1.1 01-Sep-2009
Fixed Live/Production Transaction Server parameter value to "Live".
Added "SWITCH" to the verification of the "CardType" parameter (this was not
noted in the API documentation)
v1.0 28-Aug-2009
Initial Release
Direct v3.0
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:
http://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.
Configuration Settings
Parameter
Description
Default
Enable Sage
Pay Direct
True
Module
procedure.
Vendor Login
Name
Verify With
CVC
Create Tokens
True
False
Method
Authenticate
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.
Set Order
Status
Default Order
Status
Transaction
Sage Pay
Order Status
Payment Zone
[Transactions]
If set, this payment method will only be available to
orders made within the defined zone.
Parameter
Description
Default
Transaction
Live
Server
Verify SSL
Certificate
are sent.
Proxy Server
Debug E-Mail
Address
Sort Order
True
methods.
Accept Visa
True
Accept
True
Mastercard
payments to be accepted.
Accept
Mastercard
Debit
payments to be accepted.
Accept Visa
Delta/Debit
payments to be accepted
Accept
Maestro
True
Accept Visa
True
Electron UK
Debit
True
True
True
Parameter
Description
Accept
American
Express
payments to be accepted
Accept Diners
Club
payments to be accepted.
Accept Japan
Credit Bureau
True
Accept Laser
Card
True
Accept PayPal
False
to be accepted.
Default
True
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.
Changelog
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
Setting Up PayPal
Create or log into your live or sandbox PayPal account and go to the Profile ->
Request API Credentials or API Access page. Here, under Option 1, select Grant API
Permissions or Add or Edit API Permissions to be able to manage third party
permissions.
If you have already granted third party applications access to your account profile,
select Add New Third Party to start linking your account to Sage Pay. The following
form will be presented:
Enter the following in the Third Party Permission Username field and select Lookup:
Live Account
Test Account
paypal_api1.protx.com
ppdev_1256915571_biz_api1.sagepay.com
The organization for the Live Account is displayed as SagePay, and for the
Test Account as Rik Blacow's Test Store.
After entering the Third Party Permission Username, a list of permissions will be
presented to choose which should be granted to Sage Pay. Please enable all
permissions to successfully link your PayPal account with your Sage Pay account and
select Add to save your settings.
A confirmation page will then be shown to confirm the addition of the third party
access.
Enter your live or sandbox PayPal account e-mail address to link to and select Update
to save your settings.
After entering your PayPal account e-mail address, your Sage Pay account has
successfully linked to your PayPal account and you can start accepting PayPal
payments on your store through Sage Pay.
For Sage Pay Direct, be sure to enable PayPal as a payment method in the
Administration Tool -> Modules -> Payment -> Sage Pay Direct -> Edit module
configuration settings page. This is not required for Sage Pay Form or Sage
Pay Server.