Paypal

PayPal
PayPal modules for osCommerce Online Merchant.
Chapters
osCommerce Online Merchant v2.3
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
PayPal Express Checkout
PayPal Payments Standard
PayPal Payments Pro (Direct Payment)
PayPal Payments Pro (Hosted Solution)
PayPal Express Checkout (Payflow Edition)
PayPal Payments Pro (Payflow Edition)
Log In with PayPal
Express Checkout v3.0
for osCommerce Online Merchant v2.3
PayPal Express Checkout is bundled with osCommerce Online Merchant and is also
available as a separate Add-On package existing store owners can use to upgrade to.
PayPal Express Checkout is automatically pre-configured for new osCommerce

Online Merchant installations where payments are sent to the configured store owner
e-mail address. This allows store owners to start accepting payments immediately
and to complete their PayPal merchant account when their first payments have
arrived.
The PayPal Express Checkout payment module supports the following features:
• Seamless Checkout: Customers who Log In with PayPal do not need to log in
again for Express Checkout
• Instant Update: Dynamic shipping rates are retrieved from Express Checkout
• PayPal Account Optional: Customers do not need a local store or PayPal account
and can proceed through Express Checkout as a guest
• Authorization and Sale transaction methods
• SSL Certificate verified transactions
• Sandbox server to perform test transactions
This document can be found online at:
http://library.oscommerce.com/Package&en&paypal&oscom23&express_checkout
Features
Seamless Checkout
Seamless Checkout requires the separate Log In with PayPal content module and
allows customers who have logged in through PayPal to proceed straight to the
Express Checkout flow without needing to log in again.
The Log In with PayPal content module is bundled with osCommerce Online
Merchant (since v2.3.4) and is also available as a separate Add-On package at:
http://addons.oscommerce.com/info/9067
Instant Update
As soon as the customer has logged in at PayPal or has provided their shipping
address during the Express Checkout flow, PayPal contacts your online store to
retrieve a list of applicable shipping rates and taxes for the shipping destination. The
customer is able to choose their preferred shipping rate which is passed back to the
store to use for the order.
As of osCommerce Online Merchant v2.3.4, orders can be blocked when no shipping

rate for the destination is available. If this is enabled and Instant Update detects that
no shipping rates are available, it requests the customer to select or enter a new
shipping address during the Express Checkout flow and prevents them to continue
with the order until a valid shipping destination has been selected.
Requirements
Instant Update requires the following for the shipping rates to be retrieved:
• Your store installation must be configured for and have SSL enabled.
PayPal Account Optional

PayPal Account Optional allows customers without a local or PayPal account to
proceed through the Express Checkout flow as a guest. Customers do not need to
create a PayPal account during the Express Checkout flow and their shipping and
billing information is passed back to the store to use for the order.
SSL Certificate Verified Transactions

All secured API transaction calls sent to PayPal are performed by verifying PayPal's
SSL certificates to guarantee the identity of PayPal. This is performed by using the
following public keys in order if they are available:
• ext/modules/payment/paypal/paypal.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 PayPal 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.
Some web hosting providers require a curl proxy to be used which can be
configured on the payment module configuration page.
Configuration Settings
Parameter Description Default
Enable PayPal Setting this parameter to True makes the True

Express payment method available to customers during
Checkout the checkout procedure. A "Check Out with
PayPal" image button is also shown on the
shopping cart page.
Seller Account The PayPal e-mail address of the

seller/merchant account. This is automatically
set to the configured store owner e-mail
address for new installations. This field is not
required if API credentials are used.
API Username The username to use for the PayPal API

service. This is tied to your PayPal seller
e-mail address profile to accept payments for.
API Password The password to use for the PayPal API

service.
API Signature The signature to use for the PayPal API

service.
PayPal Account Allow guests to continue through the Express False

Optional Checkout flow without logging in through
PayPal.
PayPal Instant Allow PayPal to retrieve shipping rates and True

Update taxes for the order based on the shipping
destination.
PayPal Use a static or dynamic Express Checkout Static

Checkout Image image button on the shopping cart page.
Page Style The page style to use for the Express

Checkout flow. This is defined in your PayPal
account profile.
Sale
Transaction The transaction method to use for payment

Method transactions.
The Authorization method only authorizes the

transaction which can be captured up to 29
days later, and must be captured through your
PayPal account page.
The Sale method instantly transfers the funds

to your PayPal account.
Set Order Set the status of orders made with Express Default Order
Status Checkout to this order status level. Status
PayPal PayPal transactions are logged in this private PayPal

Transactions order status level. [Transactions]
Order Status
Payment Zone If set, this payment method will only be

available to orders made within the defined
zone.
Transaction The transaction server to use for payment Live

Server transactions.
The Live server is for production use to receive

payments from customers, and the Sandbox
server is used to test transactions only.
Verify SSL Verify PayPal's identity when API True

Certificate communication calls are sent.
Proxy Server Send API communication calls through this

proxy server.
Debug E-Mail Send invalid transaction parameters to this

Address e-mail address.
Sort Order The position to show the payment method on

the checkout payment page against other
available payment methods.
Notes
Customer Accounts
PayPal Express Checkout allows guest purchases to be made without the customer
needing to create or log into their local store account. A local customer account is
however created when they return back to the store from the Express Checkout flow
to keep track of the order.
If the Set Password account content module is not installed, the automatically created
account is assigned a randomly generated password which is e-mailed to the
customers e-mail address PayPal provides.
If the Set Password account content module is installed, the password is left empty
and no e-mail is sent to the customer. The customer then has the opportunity to set
their own password in the My Account page during their session or they will only able
to log in again through Log In with PayPal or PayPal Express Checkout when their
next order is made.
Order Processing
The PayPal Express Checkout payment module has been developed to finalize the
order transaction during the Express Checkout flow. The order is confirmed during the
Express Checkout flow when the customer uses the "Pay Now" button to finalize the
order. On returning back to the store, a check on the transaction total is performed - if
it matches the order total the customer is directed to the checkout success page
otherwise, on rare occassions, they are directed to the checkout confirmation page
where they must confirm their order again.
The PayPal transaction total may differ from the order total in the following scenarios:
• when Instant Update is not enabled and the customer chooses another shipping
address which shipping rates and taxes may be applied to or removed from the
order
• when third-party Order Total modules are installed that manipulate taxes applied
to the order
• when digital downloads are purchased and the customer chooses another billing
address which taxes may be applied to or removed from the order
In the rare occassion where the PayPal transaction total does not match the order
total, the customer has the opportunity to review their order and order total
calculations (including taxes) before confirming and processing the order on the
checkout confirmation page.
Line Items
Each product that is ordered is passed on to PayPal as line items to show to the
customer during the Express Checkout flow. This includes extra third-party Order
Total modules that manipulate the order total values (eg, discounts). In rare
occassions, when the line items, shipping, and tax calculations do not match the order
total value, only the order total value is passed onto PayPal without the line items.
Add-On Package
The separate PayPal Express Checkout Add-On package is available at:
Online Demonstration
An online demonstration is available at:
http://demo.oscommerce.com
For the online demonstration, PayPal Express Checkout has been configured with
PayPal's Sandbox environment and requires a sandbox account if you wish to log in
and not checkout as a guest.
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/paypal/express.php
• includes/languages/english/modules/payment/paypal_express.php
• includes/modules/payment/paypal_express.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/paypal_express.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.0 27-May-2014
• Use API 112.
• If the Set Password account content module is installed, leave the password of
the automatically created customer account for guests empty and don't e-mail the
customer (requires osCommerce Online Merchant v2.3.4).
• Show PayPal logo on the checkout confirmation page as the payment method
instead of the module public title.
• Allow a PayPal defined Page Style to be used.
• Only add line items if line item total calculations matches order total calculations.
• Add extra Order Total modules as product line items.
• Additionally verify the PayPal transaction before the order is processed.
• Allow Instant Update to prevent the customer from proceeding through Express
Checkout if no shipping rates are available for the shipping destination (requires
osCommerce Online Merchant v2.3.4).
• Support Log In with PayPal Seamless Checkout.
• Support error code 10486 for when insufficient funds are available in the
customers PayPal account.
v2.0 08-Oct-2013
• Use API 104.
• Label public title with sandbox tag when in sandbox testing mode.
• Add Test Connection link in module configuration page.
• Verify SSL connections with PayPal public key certificate.
v1.2 19-Aug-2013
• Use API 60.
• Allow debug transaction information to be sent in an e-mail for failed transactions.
• Pre-Configure the module for new installations with the store configured store
owner e-mail address.
v1.1 18-Feb-2010
• Use API 57.

• Add support for PayPal Account Optional.
• Introduce Instant Update to have PayPal retrieve shipping rates and taxes based
on the shipping destination.
• Include PayPal transaction information in a private order status level.
• Automatically create customer accounts for guests when returning back to the
store from the Express Checkout flow. Accounts are created with an automatically
generated random password that is e-mailed to the customer.
v1.0 11-Jan-2008
• Initial Release
Payments Standard v3.1
PayPal Payments Standard 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 PayPal Payments Standard payment module supports the following PayPal
features:
• Encrypted Website Payments

• Instant Payment Notification
http://library.oscommerce.com/Package&en&paypal&oscom23&payments_standard
Features
Encrypted Website Payments
Encrypted Website Payments allows the initial transaction information to be encrypted
using public and private keys before it is sent to PayPal. This protects the order
information from being tampered with and securely initiates the transaction with
PayPal.
Please refer to Configuring Settings -> Encrypted Website Payments in this document
for more information.
Requirements
Encrypted Website Payments requires the following:
• OpenSSL; The PHP installation on your web server needs to support OpenSSL or
have access to the "openssl" program file. The location of the "openssl" program
file can be defined in a configuration parameter.
Instant Payment Notification

All orders processed through PayPal Payments Standard are verified by a separate
call PayPal automatically performs when an order has been processed. PayPal sends
an Instant Payment Notification (IPN) to your store with the order information which is
then verified and logged with the order.
The results of the verification are logged in a private order status that can be seen
when viewing the order.


Payments payment method available to customers
Standard during the checkout procedure.
Seller E-Mail The PayPal seller account e-mail address

Address to accept payments for.
Primary E-Mail The primary PayPal seller account e-mail

Address address for when multiple PayPal e-mail
addresses have been setup with the
account. This is used to verify the IPN with
and can be left empty.
Page Style The page style to use for the payment flow.
This is defined in your PayPal account
profile.
Transaction The transaction method to use for payment Sale

The Authorization method only authorizes

the transaction which can be captured up to
29 days later, and must be captured
through your PayPal account page.
The Sale method instantly transfers the

funds to your PayPal account.
Set Preparing The customers order is saved in the Preparing

Order Status database on the checkout confirmation [PayPal
page before the customer is forwarded to Standard]
PayPal 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 PayPal and returns to the store with the

link provided by PayPal. The order status is
also updated when the Instant Payment
Notification from PayPal is received.
If the customer does not finalize the

payment transaction at PayPal, the order
remains in the database with this order
status and can be removed after a period of
time.
Set PayPal The orders status will be updated to this Default Order
Acknowledged value when the customer returns back to Status
Order Status the store after payment has been made at
PayPal or when the Instant Payment
Notification is received and the order has
been verified.
PayPal PayPal transactions are logged in this PayPal

Transactions private order status level. [Transactions]
Order Status

zone.
Gateway Server The gateway server to use for payment Live

transactions.
The Live server is for production use to

receive payments from customers, and the
Sandbox server is used to test transactions
only.


proxy server.

Enable Setting this parameter to True encrypts the False

Encrypted parameters sent to PayPal during the
Website payment transaction.
Payments
Your Private Key The location and filename of your private

key to use for signing the payment
transaction.
Your Public The location and filename of your public

Certificate certificate to use for signing the payment
transaction.
PayPals Public The location and filename of the PayPal

Certificate public certificate to use for encrypting the
payment transaction.
Your PayPal The public certificate ID that PayPal should

Public Certificate use to decrypt the payment transaction.
ID This is defined at your PayPal Encrypted
Payment Settings Profile page.
Working The working directory to create temporary

Directory files. All files created are automatically
deleted when they are no longer needed.
OpenSSL The location and filename of the OpenSSL /usr/bin/openssl

Location "openssl" program file used when PHP has
not been configured with OpenSSL natively.
Sort Order The position to show the payment method

on the checkout payment page against
other available payment methods.
Encrypted Website Payments

The following steps are required before Encrypted Website Payments is enabled:
1. Generate your private key.
2. Generate your public certificate.
3. Upload your public certificate to your PayPal account.
4. Download the PayPal public certificate from the PayPal website.
5. Update module configuration parameters.
and optionally:
6. Block non-encrypted website payments.
Private keys and public certificates can be generated by using the "openssl" program
file.
1. Generate your private key

Enter the following OpenSSL command to generate your private key. The command
generates a 1024-bit RSA private key that is stored in the file my-prvkey.pem:
openssl genrsa -out my-prvkey.pem 1024
2. Generate your public certificate

Your public certificate must be in PEM format. To generate your certificate, enter the
following OpenSSL command, which generates a public certificate in the file my-
pubcert.pem:
openssl req -new -key my-prvkey.pem -x509 -days 365 -out my-pubcert.pem
The following questions will be prompted:
Question Example
Country Name (2 letter code) US
State or Province Name (full name) California
Locality Name (eg, city) Beverly Hills
Organization Name (eg, company) Your Store Name
Organizational Unit Name (eg, section)
Common Name (e.g. server FQDN or YOUR name) Your Store URL Address
Email Address Your E-Mail Address

3. Upload your public certificate to your PayPal account
To upload your public certificate to your PayPal account:
1. Log in to your PayPal Business or Premier account.

2. Click the Profile subtab.
3. In the Hosted Payment Settings column, click the Website Payment Certificates
link.
4. Scroll down the page to the Your Public Certificates section, and click the Add
button.
5. Click the Browse button, and select the public certificate that you want to upload to
PayPal (my-pubcert.pem).
6. Click the Add button.
After your public certificate uploads successfully, it appears in the Your Public
Certificates section of the Website Payment Certificates page.
7. Note the certificate ID that PayPal assigned to your public certificate.
4. Download the PayPal public certificate from the PayPal

website
To download the PayPal public certificate:
1. Log in to your PayPal Business or Premier account.

3. In the Hosted Payment Settings column, click the Website Payment Certificates
link.
4. Scroll down the page to the PayPal Public Certificate section.
5. Click the Download button, and save the file in a secure location.
5. Update module configuration parameters.

Copy the following files to a secure location your web server:
• my-prvkey.pem; Your private key generated in step 1.

• my-pubcert.pem; Your public certificate generated in step 2.
• paypal_cert_pem.txt; The PayPal public certificate downloaded in step 4.
Create a working directory on the web server that the web server has write access to.
Review and update the module Encrypted Website Payments parameters:
Parameter Value
Enable Encrypted Set to True to enable Encrypted Website Payments.

Website Payments
Your Private Key The location and filename of your private key; my-
prvkey.pem generated in Step 1.
Your Public The location and filename of your public certificate; my-
Certificate pubcert.pem generated in Step 2.
PayPals Public The location and filename of the PayPal public certificate;
Certificate paypal_cert_pem.txt downloaded in Step 4.
Your PayPal Public Your PayPal stored Certificate ID; noted in Step 3.
Certificate ID
Working Directory The working directory to create temporary files. All files
created are automatically deleted when they are no longer
needed.
OpenSSL Location The location and filename of the OpenSSL "openssl"

program file used when PHP has not been configured with
OpenSSL natively.
6. Block non-encrypted website payments.

Optionally, orders processed through non-encrypted website payments can be
blocked for extra security. This is recommended only if Encrypted Website Payments
has been enabled.
To block payments from unprotected and non-encrypted PayPal Payments Standard

orders:
1. Log in to your PayPal Premier account or Business account.

3. In the Hosted Payment Settings column, click the Website Payments Preferences
link.
4. Scroll down to the Encrypted Website Payments section.
5. Next to the Block Non-encrypted Website Payment label, select the On radio
button.
6. Scroll to the bottom of the page, and click the Save button.
Notes
Order Processing
When the customer goes through the checkout procedure and lands on the checkout
confirmation page, their order is saved in the database with a private order status (by
default, Preparing [PayPal Standard]). The order status is updated to an
acknowledged order status (by default, the default order status level) when the
customer returns back to the store from PayPal after payment has been made, or
when the IPN notification is received if the customer didn't return back to the store.
If the customer did not finalize the payment at PayPal and does not return back to the
store, the order remains in the database with the Preparing [PayPal Standard] order
status and can be safely deleted after a period of time.
Line Items
customer during the payment flow. This includes extra third-party Order Total modules
that manipulate the order total values (eg, discounts). In rare occassions, when the
line items, shipping, and tax calculations do not match the order total value, only the
order total value is passed onto PayPal without the line items.
Add-On Package
The separate PayPal Payments Standard Add-On package is available at:
For the online demonstration, PayPal Payments Standard has been configured with
PayPal's Sandbox environment and requires a sandbox account if you wish to log in
and not checkout as a guest.
After extracting the add-on package, copy the files located in the catalog directory to
correct directory structure as extracted from the add-on package.
• ext/modules/payment/paypal/standard_ipn.php
• includes/languages/english/modules/payment/paypal_standard.php
• includes/modules/payment/paypal_standard.php
• includes/languages/LANGUAGE/modules/payment/paypal_standard.php
database.
Changelog
v3.1 01-Jun-2014
• Include line items when line item total calculations matches order total value.
v3.0 27-May-2014
v2.0 22-Aug-2013
• Add additional checks when processing the order.
v1.1 28-May-2013
• Add Primary Seller E-Mail Address parameter for cases when it is different to the
Seller E-Mail Address.
v1.0 11-Jan-2008
• Initial Release
Payments Pro (Direct
Payment) v3.0
PayPal Payments Pro (Direct Payment) allows credit and debit cards to be accepted
directly on your online store during the checkout flow without the customer having to
leave the site.
PayPal Payments Pro (Direct Payment) 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 PayPal Payments Pro (Direct Payment) payment module supports the following
features:
• Process credit and debit cards directly during the checkout flow
http://library.oscommerce.com/Package&en&paypal&oscom23&payments_pro_direct
Features
Requirements
PayPal Express Checkout
PayPal Payments Pro (Direct Payment) requires the additional PayPal Express
Checkout payment module to be installed and enabled on your online store. PayPal
Express Checkout is bundled with osCommerce Online Merchant and is also
available as a separate Add-On package to download.
This module will not function until PayPal Express Checkout has been installed and
enabled.

Payments Pro payment method available to customers
(Direct Payment) during the checkout flow. The credit and
debit card information is entered on the

e-mail address profile to accept payments
for.

service.

service.


29 days later, and must be captured through
your PayPal account page.

Set Order Status Set the status of orders made with this Default Order
payment module to this order status level. Status

Order Status

zone.


only.


proxy server.


on the checkout payment page against other
Accept Visa Setting this parameter to True allows Visa True

cards to be accepted for payments.
Accept Setting this parameter to True allows True

MasterCard MasterCard cards to be accepted for
payments.
Accept Discover Setting this parameter to True allows True

Discover cards to be accepted for payments.
Accept American Setting this parameter to True allows True

Express American Express cards to be accepted for
payments.
Accept Maestro Setting this parameter to True allows True

Maestro cards to be accepted for payments.
Notes
Line Items
Each product that is ordered is passed on to PayPal as line items to tie to the
transaction. This includes extra third-party Order Total modules that manipulate the
order total values (eg, discounts). In rare occassions, when the line items, shipping,
and tax calculations do not match the order total value, only the order total value is
passed onto PayPal without the line items.
Add-On Package
The separate PayPal Payments Pro (Direct Payment) Add-On package is available at:
For the online demonstration, PayPal Payments Pro (Direct Payment) has been
configured with PayPal's Sandbox environment and requires a testing card number
for purchases.
• includes/languages/english/modules/payment/paypal_pro_dp.php
• includes/modules/payment/paypal_pro_dp.php
• includes/languages/LANGUAGE/modules/payment/paypal_pro_dp.php
database.
Changelog
v3.0 27-May-2014
• Use API 112.
• Add line items if line item total calculations matches order total calculations.
v2.0 20-Aug-2013
• Use API 104.
• Remove card entry fields from the checkout payment page (now only entered on
the checkout confirmation page).
• Dynamically update card entry fields depending on card type.
• Allow card types to be enabled/disabled.
v1.1 22-Jan-2008
• Add configuration parameter to control where the card details should be collected;
either on the checkout payment or checkout confirmation page. This is needed for
2.2MS2 compatibility which can only collect card details on the checkout payment
page.
v1.0 11-Jan-2008
• Initial Release
Payments Pro (Hosted
Solution) v1.0
PayPal Payments Pro (Hosted Solution) allows credit and debit cards to be accepted
directly on your online store during the checkout flow without the customer having to
leave the site.
PayPal Payments Pro (Hosted Solution) is bundled with osCommerce Online

The PayPal Payments Pro (Hosted Solution) payment module supports the following
features:
• Process credit and debit cards directly during the checkout flow
http://library.oscommerce.com/Package&en&paypal&oscom23&payments_pro_hosted
Features

(Hosted Solution) during the checkout flow. The credit and
debit card information is entered on the

e-mail address profile to accept payments
for.

service.

service.
Seller E-Mail The PayPal seller account e-mail address to

Address accept payments for.
Primary E-Mail The primary PayPal seller account e-mail

Address address for when multiple PayPal e-mail
addresses have been setup with the
account. This is used to verify the IPN with
and can be left empty.


29 days later, and must be captured through

Set Preparing The customers order is saved in the Preparing

Order Status database on the checkout confirmation page [PayPal Pro
before the customer is forwarded to PayPal HS]
if they chose PayPal as their payment
method. 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 PayPal and returns to the store with the
link provided by PayPal. The order status is
also updated when the Instant Payment
Notification from PayPal is received.
If the customer does not finalize the

payment transaction at PayPal, the order
remains in the database with this order
status and can be removed after a period of
time.
Set PayPal The orders status will be updated to this Default Order
Acknowledged value when the customer returns back to the Status
Order Status store after payment has been made at
PayPal or when the Instant Payment
Notification is received and the order has
been verified.

Order Status

zone.
Gateway Server The gateway server to use for payment Live

transactions.


only.


proxy server.


on the checkout payment page against other
Add-On Package
The separate PayPal Payments Pro (Hosted Solution) Add-On package is available
at:
For the online demonstration, PayPal Payments Pro (Hosted Solution) has been
for purchases.
• ext/modules/payment/paypal/hosted_checkout.php
• ext/modules/payment/paypal/images/hss_load.gif
• ext/modules/payment/paypal/pro_hosted_ipn.php
• includes/languages/english/modules/payment/paypal_pro_hs.php
• includes/modules/payment/paypal_pro_hs.php
• includes/languages/LANGUAGE/modules/payment/paypal_pro_hs.php
database.
Changelog
v1.0 27-May-2014
• Initial Release
Express Checkout (Payflow
Edition) v3.0
PayPal Express Checkout (Payflow Edition) 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 PayPal Express Checkout (Payflow Edition) payment module supports the following
features:

http://library.oscommerce.com/Package&en&paypal&oscom23&express_checkout_payflow
Features
All secured API transaction calls sent to PayPal are performed by verifying PayPal's SSL
certificates to guarantee the identity of PayPal. This is performed by using the following
public keys in order if they are available:
A test connection link is available on the payment module configuration page which can
be used to test if API transaction calls to PayPal 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.
Requirements
PayPal Payments Pro (Payflow Edition)
PayPal Express Checkout (Payflow Edition) requires the additional PayPal Payments
Pro (Payflow Edition) payment module to be installed and enabled on your online store.
PayPal Payments Pro (Payflow Edition) is bundled with osCommerce Online Merchant
and is also available as a separate Add-On package to download.
This module will not function until PayPal Payments Pro (Payflow Edition) has been
installed and enabled.

Express Checkout payment method available to customers during
(Payflow Edition) the checkout procedure. A "Check Out with
PayPal" image button is also shown on the
shopping cart page.
Vendor The merchant login ID that was created when a

Payments Pro account was registered.
User If one or more additional users are setup on the

account, this value is the ID of the user
authorized to process transactions. If, however,
no additional users were setup on the account,
this has the same value as Vendor.
Password The 6- to 32-character password that was

defined during the registering of the account.
Partner The ID provided by the authorized PayPal

Reseller who registered you for the Payflow
SDK. If the account was purchased directly
from PayPal, use PayPalUK.
Page Style The page style to use for the Express

Checkout flow. This is defined in your PayPal
account profile.


days later, and must be captured through your
PayPal account page.

Set Order Status

Set the status of orders made with Express Default Order

Checkout to this order status level. Status

Order Status

zone.

The Live server is for production use to receive

payments from customers, and the Sandbox
server is used to test transactions only.


proxy server.


Notes
Customer Accounts
PayPal Express Checkout (Payflow Edition) allows guest purchases to be made without
the customer needing to create or log into their local store account. A local customer
account is however created when they return back to the store from the Express
Checkout flow to keep track of the order.
If the Set Password account content module is not installed, the automatically created
account is assigned a randomly generated password which is e-mailed to the customers
e-mail address PayPal provides.
If the Set Password account content module is installed, the password is left empty and
no e-mail is sent to the customer. The customer then has the opportunity to set their own
password in the My Account page during their session or they will only able to log in
again through Log In with PayPal or PayPal Express Checkout when their next order is
made.
Line Items
customer during the Express Checkout flow. This includes extra third-party Order Total
modules that manipulate the order total values (eg, discounts). In rare occassions, when
the line items, shipping, and tax calculations do not match the order total value, only the
order total value is passed onto PayPal without the line items.
Add-On Package
The separate PayPal Express Checkout (Payflow Edition) Add-On package is available
at:
For the online demonstration, PayPal Express Checkout (Payflow Edition) has been
configured with PayPal's Sandbox environment and requires a sandbox account if you
wish to log in and not checkout as a guest.
• ext/modules/payment/paypal/express_payflow.php
• includes/languages/english/modules/payment/paypal_pro_payflow_ec.php
• includes/modules/payment/paypal_pro_payflow_ec.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
• includes/languages/LANGUAGE/modules/payment/paypal_pro_payflow_ec.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.
database.
Changelog
v3.0 27-May-2014
• Automatically create customer accounts for guests when returning back to the store
from the Express Checkout flow.
• If the Set Password account content module is installed, leave the password of the
automatically created customer account for guests empty and don't e-mail the
customer (requires osCommerce Online Merchant v2.3.4).
• Allow a PayPal defined Page Style to be used.
• Only add line items if line item total calculations matches order total calculations.
• Add extra Order Total modules as product line items.
v2.0 22-Aug-2013
v1.0 11-Jan-2008
• Initial Release
Payments Pro (Payflow
Edition) v3.0
PayPal Payments Pro (Payflow Edition) allows credit cards to be accepted directly on
your online store during the checkout flow without the customer having to leave the
site.
PayPal Payments Pro (Payflow Edition) is bundled with osCommerce Online

The PayPal Payments Pro (Payflow Edition) payment module supports the following
features:
• Process credit cards directly during the checkout flow

http://library.oscommerce.com/Package&en&paypal&oscom23&payments_pro_payflow
Features
Requirements
PayPal Express Checkout (Payflow Edition)
PayPal Payments Pro (Payflow Edition) requires the additional PayPal Express
Checkout (Payflow Edition) payment module to be installed and enabled on your
online store. PayPal Express Checkout (Payflow Edition) is bundled with
osCommerce Online Merchant and is also available as a separate Add-On package
to download.
This module will not function until PayPal Express Checkout (Payflow Edition) has
been installed and enabled.

(Payflow Edition) during the checkout flow. The credit and debit
card information is entered on the checkout
confirmation page.
Vendor The merchant login ID that was created when

a Payments Pro account was registered.
User If one or more additional users are setup on

the account, this value is the ID of the user
authorized to process transactions. If,
however, no additional users were setup on
the account, this has the same value as
Vendor.
Password The 6- to 32-character password that was

defined during the registering of the account.
Partner The ID provided by the authorized PayPal

Reseller who registered you for the Payflow
SDK. If the account was purchased directly
from PayPal, use PayPalUK.


days later, and must be captured through

Set Order Status Set the status of orders made with this Default Order
payment module to this order status level. Status

Order Status

zone.


only.


proxy server.


Notes
Line Items
Each product that is ordered is passed on to PayPal as line items to tie to the
transaction. This includes extra third-party Order Total modules that manipulate the
order total values (eg, discounts). In rare occassions, when the line items, shipping,
and tax calculations do not match the order total value, only the order total value is
passed onto PayPal without the line items.
Add-On Package
The separate PayPal Payments Pro (Payflow Edition) Add-On package is available
at:
For the online demonstration, PayPal Payments Pro (Payflow Edition) has been
for purchases.
• includes/languages/english/modules/payment/paypal_pro_payflow_dp.php
• includes/modules/payment/paypal_pro_payflow_dp.php
• includes/languages/LANGUAGE/modules/payment/paypal_pro_payflow_dp.php
database.
Changelog
v3.0 27-May-2014
• Add line items if line item total calculations matches order total calculations.
v2.0 20-Aug-2013
• Remove card entry fields from the checkout payment page (now only entered on
the checkout confirmation page).
v1.1 22-Jan-2008
• Add configuration parameter to control where the card details should be collected;
either on the checkout payment or checkout confirmation page. This is needed for
2.2MS2 compatibility which can only collect card details on the checkout payment
page.
• Split card owner name into two fields for the first and last name.
v1.0 11-Jan-2008
• Initial Release
Log In with PayPal v1.0
Log In with PayPal allows guests to authenticate themselves through PayPal and to
securely share their personal and shipping address information without the need to
create a customer account on your store. The shared information is used to calculate
taxes and to retrieve a list of available shipping rates for their order based on their
shipping address.
When guests authenticate themselves through PayPal, their default payment method
is automatically set to PayPal Express Checkout which they can use without needing
to sign into again.
Log In with PayPal is bundled with osCommerce Online Merchant (since v2.3.4) and
is also available as a separate Add-On package existing store owners can use to
upgrade to.
Log In with PayPal Mini-Browser Window
The Log In with PayPal content module supports the following features:
• Seamless Checkout: Customers who Log In with PayPal do not need to log in
again for Express Checkout
• SSL Certificate verified API calls
• Sandbox server to perform test logins
http://library.oscommerce.com/Package&en&paypal&oscom23&log_in
Features
Seamless Checkout
Seamless Checkout requires the separate PayPal Express Checkout payment
module and allows customers who have logged in through PayPal to proceed straight
to the Express Checkout flow without needing to log in again.
The PayPal Express Checkout payment module is bundled with osCommerce Online
Merchant and is also available as a separate Add-On package at:
SSL Certificate Verified API Calls

All API calls sent to PayPal are performed by verifying PayPal's SSL certificates to
guarantee the identity of PayPal. This is performed by using the following public keys
in order if they are available:
A test connection link is available on the content module configuration page which
can be used to test if API calls to PayPal 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 content module configuration page however it is highly discouraged to disable.
configured on the content module configuration page.
Requirements
Log In with PayPal requires the following:
• PayPal Application; a PayPal Application needs to be created at the PayPal

Developer site. The API credentials assigned to the application need to be entered
in the module configuration page.
• Content Modules; as Log In with PayPal 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.
• Set Password Content Module; it is important to enable the Set Password content
module to automatically replace the My Account -> Change Password link to a Set
Password link.
Enable Log In Setting this parameter to True adds the True

with PayPal content module to the login page.
Client ID The Client ID of the PayPal Application to use.
Secret The Secret of the PayPal Application to use.
Theme A Blue and Neutral theme is available for the Blue

design of the Log In with PayPal button.
Information The attributes the customer shares. All

Personal
Requested From attributes are selected by default. The
Information
Customers minimum attributes required are defined by a
radio button which cannot be deselected. Full Name
Date of Birth
Age Range
The selected attributes must match the Gender
attributes selected in the PayPal Address
Application settings. Information
Email
Address
Street
Address
City
State
Country
Zip Code
Phone
Account
Information
Account
Status
(verified)
Account
Type
Account
Creation
Date
Time Zone
Locale
Language
Checkout
Express
Seamless
Checkout
Server Type The server to use for API calls. Live
The Live server is for production use to use

with real PayPal accounts, and the Sandbox
server is used to test with PayPal Sandbox
account logins.
Verify SSL Verify PayPal's identity when API calls are True
Certificate sent.
Proxy Server Send API calls through this proxy server.
Content Width The width of the login page to utilize to show Full
the Log In with PayPal content.
Full utilizes the full width of the page, and Half

only half the width of the page.
Sort Order The position to show the content of Log In with

PayPal against other available content
modules.
Notes
Customer Accounts
Log In with PayPal allows guest purchases to be made without the customer needing
to create or log into their local store account. As a customer account is needed to
track orders, when the customer returns back to the store after logging in through
PayPal, either:
• they are automatically logged into their store account matching the same e-mail
address, or
• a store account based on their PayPal e-mail address is automatically created
with an empty password
Customers cannot log into automatically created store accounts until they set a
password on the My Account -> Set Password page, and can continue to log in
through PayPal until a password has been set.
Please note that the sharing of customer email addresses does not authorize
your business to email consumers. For any communications not related to a
purchase (such as marketing emails, newsletters, and offers), you must
continue to present your customers with separate opt-in/out options.
Add-On Package
The separate Log In with PayPal Add-On package is available at:
For the online demonstration, Log In with PayPal has been configured with PayPal's
Sandbox environment and requires a sandbox account to log into.
• admin/ext/modules/content/paypal/login.php
• includes/languages/english/modules/content/login/cm_paypal_login.php
• includes/modules/content/login/cm_paypal_login.php
• includes/modules/content/login/templates/paypal_login.php
• includes/languages/LANGUAGE/modules/content/login/cm_paypal_login.php
When the files have been copied to their appropriate locations, the content module
will be available on the Administration Tool -> Modules -> Content -> Install Module
page where it can be installed, or on the Administration Tool -> Modules -> Content
database.
Changelog
v1.0 27-May-2014
• Initial Release

Paypal

Uploaded by

Copyright:

Available Formats

Paypal

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Paypal

Uploaded by

Copyright:

Available Formats

What are the main features of PayPal Express Checkout?

What are the main features of PayPal Express Checkout?

What are the requirements for Instant Update?

What are the requirements for Instant Update?

PayPal

PayPal modules for osCommerce Online Merchant.

PayPal Express Checkout is automatically pre-configured for new osCommerce

This document can be found online at:

As of osCommerce Online Merchant v2.3.4, orders can be blocked when no shipping

PayPal Account Optional

SSL Certificate Verified Transactions

Enable PayPal Setting this parameter to True makes the True

Seller Account The PayPal e-mail address of the

API Username The username to use for the PayPal API

API Password The password to use for the PayPal API

API Signature The signature to use for the PayPal API

PayPal Account Allow guests to continue through the Express False

PayPal Instant Allow PayPal to retrieve shipping rates and True

PayPal Use a static or dynamic Express Checkout Static

Page Style The page style to use for the Express

Transaction The transaction method to use for payment

The Authorization method only authorizes the

The Sale method instantly transfers the funds

PayPal PayPal transactions are logged in this private PayPal

Payment Zone If set, this payment method will only be

Transaction The transaction server to use for payment Live

The Live server is for production use to receive

Verify SSL Verify PayPal's identity when API True

Proxy Server Send API communication calls through this

Debug E-Mail Send invalid transaction parameters to this

Sort Order The position to show the payment method on

The file listing is as follows:

• Use API 112.

• Allow a PayPal defined Page Style to be used.

• Add extra Order Total modules as product line items.

• Additionally verify the PayPal transaction before the order is processed.

• Support Log In with PayPal Seamless Checkout.

• Use API 104.

• Add Test Connection link in module configuration page.

• Verify SSL connections with PayPal public key certificate.

• Use API 60.

• Allow debug transaction information to be sent in an e-mail for failed transactions.

• Use API 57.

• Include PayPal transaction information in a private order status level.

• Encrypted Website Payments

This document can be found online at:

Instant Payment Notification

SSL Certificate Verified Transactions

Enable PayPal Setting this parameter to True makes the True

Seller E-Mail The PayPal seller account e-mail address

Primary E-Mail The primary PayPal seller account e-mail

Transaction The transaction method to use for payment Sale

The Authorization method only authorizes

The Sale method instantly transfers the

Set Preparing The customers order is saved in the Preparing

The order status is updated again when the

at PayPal and returns to the store with the

If the customer does not finalize the

PayPal PayPal transactions are logged in this PayPal

Payment Zone If set, this payment method will only be