Inc. Designated trademarks and brands are the property of their respective owners.
Notice of Non-Liability
PayPal, Inc. and the authors assume no liability for errors or omissions, or for damages, resulting from
the use of this Manual or the information contained in this Manual.
Website Payments Standard Checkout Integration GuideNovember 200511
List of Examples
12November 2005 Website Payments Standard Checkout Integration Guide
Preface
This Document
This document, the PayPal Website Payments Standard Checkout Integration Guide, is a
complete revision of the version issued in September 2005.
Intended Audience
This document is for merchants whose websites obtain payments using PayPal features.
Notational Conventions
This document uses typefaces to identify the characteristics of text. These typefaces and the
characteristics they imply are described below:
TypefaceHow Used
serif italicsA document title.
A term being discussed or defined.
For example: A file is a readable or writable stream of characters.
Boolean values (not keywords).
For example: The function returns true if it encounters an error.
monospaced Pathnames or file names that appear in body text frames.
Code-related names that appear in body text frames. Such names are used for
functions, callbacks, arguments, data structures, and fields.
For example: AbstractResponseType is the SOAP response type definition on
which all PayPal API response methods are based.
Components of internet protocol requests and responses, such as HTTPS and
FORM variables.
For example: The PayPal system uses a method=POST request to return IPN
status variables related to subscriptions, such as txn_type.
Serif boldUser interface names such as window names or menu selections.
For example: On the Profile page, click Email to confirm your email address.
San-serif
oblique
Placeholders used in the context of a format or programming standard or formal
descriptions of PayPal system syntax. Placeholders indicate values or names that
the reader should provide.
Example: For example, amount is the variable for a single-item shopping cart, but
amount_
is the item amount for the third item in a multiple-item shopping cart.
X is the name of the variable for a multi-item shopping cart. amount_3
Website Payments Standard Checkout Integration GuideNovember 200513
Preface
To convey additional information, this document may also apply color and underlining to words or
phrases that use the typefaces described above. Such use is described below:
Text attributeHow Used
xxxxxx
xxxxxx
Documentation Problems
Hypertext link to a page in the current document or to another document in the set.
Hypertext link to a URL or that initiates a web action, such as sending mail.
If you discover any errors in or have any problems with this documentation, please mail us by
following the instructions below. Describe the error or problem in as much detail as possible
and give us the document title, the date of the document (located at the foot of every page),
and the page number or page range.
To contact Customer Service about documentation problems:
1. Go to
https://www.paypal.com/.
2. Click Help in the upper left corner of the page.
3. Click Contact Us in the lower left corner of the page.
4. In the Help by Email section, click Contact PayPal Customer Service.
5. Complete the form.
To contact Developer Technical Support about documentation problems:
1. Go to
https://developer.paypal.com/.
2. Log in to your account by entering your email address and password in the Member Log
In box.
3. Click Help Center at the bottom of the box on the right side of the page.
4. Click Email PayPal Technical Support.
5. Complete the form.
14November 2005 Website Payments Standard Checkout Integration Guide
1
How Website Payments Standard
Works
The PayPal Website Payments Standard Checkout Integration Guide describes how you use
Website Payments Standard. Website Payments Standard consists of HTML FORMs on your
website that direct your customer’s web browser to the PayPal website at
http://www.paypal.com in order to pay you and then return the customer to your website.
Figure 1.1, “Basic Website Payments Standard Page Sequence,” shows the basic sequence of
web browser pages when a customer pays you with PayPal Website Payments Standard.
FIGURE 1.1Basic Website Payments Standard Page Sequence
All features of Website Payments Standard are variations on this basic page sequence. You use
HTML FORM variables and the settings in your PayPal account Profile to affect the behavior
of the basic sequence.
Website Payments Standard Checkout Integration GuideNovember 200515
How Website Payments Standard Works
1
Example of the Basic Page Sequence
Example of the Basic Page Sequence
Here’s an example of the basic page sequence of Website Payments Standard. Like all
examples of pages in this guide, this example is based on the PayPal sample integration, which
demonstrates how PayPal has been integrated with the fictitious online store called
“DesignerFotos.”
BEGIN. The customer chooses to pay with PayPal on your website.
FIGURE 1.2Beginning of Basic Page Sequence on Your Website
This example illustrates PayPal Buy Now, which is discussed in Chapter 3, “Single-Item
Payment: Buy Now and Donations.”
16November 2005 Website Payments Standard Checkout Integration Guide
How Website Payments Standard Works
Example of the Basic Page Sequence
The customer logs in to PayPal.
FIGURE 1.3Customer Logs In to or Signs Up for PayPal
1
If the customer were new to PayPal, the customer could choose to sign up for a PayPal
account.
Website Payments Standard Checkout Integration GuideNovember 200517
How Website Payments Standard Works
1
Example of the Basic Page Sequence
On PayPal, the customer reviews the details of the payment and makes the payment.
FIGURE 1.4Customer Reviews Payment
At this point, the customer can choose among funding sources (credit cards, debit cards, or
bank accounts recorded in the PayPal accounts) with which to pay you and can also choose
among shipping addresses stored on PayPal. This example does not show the pages containing
these options.
18November 2005 Website Payments Standard Checkout Integration Guide
How Website Payments Standard Works
Example of the Basic Page Sequence
The customer sees a payment confirmation page on PayPal and clicks Return to
Merchant.
FIGURE 1.5Payment Confirmation or “You Made a Payment” Page on PayPal
1
Website Payments Standard Checkout Integration GuideNovember 200519
How Website Payments Standard Works
1
Example of the Basic Page Sequence
END. The customer is returned to your website.
FIGURE 1.6Customer Returns to Your Website
20November 2005 Website Payments Standard Checkout Integration Guide
How You Get Your Money
After a customer makes a payment, your PayPal account lists the payment in your Account
History, as shown below.
FIGURE 1.7Account History: Recent Activity
How Website Payments Standard Works
How You Get Your Money
1
Notifications You Receive
You can be notified of payments in four ways: email, History Log, Downloadable History
Log, and Instant Payment Notification (IPN).
Email
You receive email notification in the following cases:
z Successful payment
z Pending payment
z Canceled payment
If you do not want to receive email notification:
1. Click the Profile subtab of the My Accounttab.
2. Click the Notifications link in the Account Information column.
Website Payments Standard Checkout Integration GuideNovember 200521
How Website Payments Standard Works
1
Notifications You Receive
3. Under the Payment Notifications heading, clear the I receive PayPal Website Payments
and Instant Purchase checkbox.
4. Click Save.
Transaction History
Your transaction history (also called your “History) displays information about your
payments. The status of each payment is one of the following statuses:
z Completed: The transaction was successful and the money was credited to your account
z Cleared: The payment cleared the sender’s account and was credited to your account
z Uncleared: The payment has not cleared the sender’s account yet
Downloadable History Log
You can download copies of your transaction history to your computer. You can specify a date
range for the transactions and the format of the downloadable file. The file contains a record of
your transactions.
To learn more about Downloadable History Logs, see the Order Management Integration Guide.
Instant Payment Notification (IPN)
Instant Payment Notification is a mechanism by which you to receive transaction data. IPN
posts individual transaction information to a URL on your website that you have programmed
to process this incoming data. To use IPN, you must activate it, because it is disabled by
default.
If IPN is activated, you receive a notification in the following cases:
z When a payment is first sent, indicating that the status of the payment is Completed or
Pending
z When a payment clears, fails, or is denied, if the status was pending
To learn more about IPN, see “Instant Payment Notification: notify_url” on page 96 and the
Order Management Integration Guide.
22November 2005 Website Payments Standard Checkout Integration Guide
How Website Payments Standard Works
How To Use This Guide
How To Use This Guide
Website Payments Standard has two primary components: Buy Now or Donations buttons and
Shopping Cart. Both are constructed with the same basic set of HTML FORM variables. You
can affect their behavior and appearance with settings in your account Profile and with
additional FORM variables.
The following table summarizes the contents of this guide.
TABLE 1.1How To Use This Guide
FeatureDescriptionSee Also...
1
Buy Now or
Paying for single items from your website.
Donations
Shopping CartPaying for multiple items from your website. It
comes in two forms: a shopping cart hosted on
PayPal’s website and as HTML FORM
variables for use in third-party shopping carts.
Custom Payment PagesAccount Profile settings that brand PayPal’s pages
with your own colors and images.
“Account Optional” or
Website Payments
Express
Auto ReturnAccount Profile settings that eliminate PayPal’s
Automatic Calculation
of Shipping, Handling,
and Tax
Customer Contact
Telephone
Account Profile setting that allows a customer to
pay you with credit or debit cards without having a
PayPal account.
payment receipt page (step 4 in
Website Payments Standard Page Sequence
Account Profile settings that calculate shipping and
handling costs and sales tax for you.
Account Profile setting that sends you the
customer’s contact telephone number.
Figure 1.1, “Basic
).
Chapter 3, “Single-Item
Payment: Buy Now and
Donations
”
Chapter 4, “Multiple-Item
Payment: Shopping Cart
”
“Branding PayPal’s Payment
Pages” on page 29
“Account Optional or Website
Payments Express” on
page 35
“Auto Return” on page 43
“Automatic Calculation of
Shipping and Handling Cost
and Tax” on page 45
“Getting Customer Contact
Telephone Numbers” on
page 49
Multi-User AccessAccount Profile setting that allows up to seven
email addresses to share your Business account.
Encrypted Website
Payments
Encrypt payment information before it is sent to
PayPal to protect customer data.
“Multi-User Access to Your
PayPal Account” on page 55
Chapter 5, “Encrypted
Website Payments
”
Other Standard Products and Features
Website Payments Standard also includes other products and features not detailed in this
guide:
Website Payments Standard Checkout Integration GuideNovember 200523
How Website Payments Standard Works
1
Related Online Information
z Instant Payment Notification (IPN) and Payment Data Transfer (PDT) are HTML FORM-
based mechanisms to send information about payments to programs on your website. IPN
and PDT are described in the
z Subscriptions and Recurring Payments, which are described in the Subscriptions and
Recurring Payments Guide
Website Payments Pro
Website Payments Pro consists of PayPal Express Checkout and the Direct Payment
Application Programming Interfaces (APIs). Rather than being based solely on HTML FORM
variables (as is Website Payments Standard), these products rely on the PayPal Web Services
API. For more information, see the
Authorization & Capture
Authorization & Capture supplements both Website Payments Standard and Website
Payments Pro with PayPal’s enhancements to conventional credit card authorization and
payment capture. It has both PayPal website tools and a Web Services Application
Programming Interface (API). For more information, see the
Integration Guide.
Order Management Integration Guide.
Website Payments Pro Integration Guide.
Authorization & Capture
Related Online Information
Consult the following URLs for information about PayPal’s fees, online security, user
agreement and related policies, online help, and customer service.
TABLE 1.2Hyperlinks for Fees, Security, User Agreement, Policies, Online Help, and Customer
24November 2005 Website Payments Standard Checkout Integration Guide
How Website Payments Standard Works
Complementary Documentation
Complementary Documentation
All PayPal technical documentation is listed here. The description of each guide indicates its
subject matter and documentation necessary for effective use of the guide.
TABLE 1.3PayPal Technical Documentation
Guide TitleDescriptionPrerequisites
1
Website Payments
Standard Integration
Guide
Express Checkout
Integration Guide
Website Payments
Pro Integration Guide
Authorization &
Capture Integration
Guide
Details basic PayPal payment process for shopping cart and single-item purchase.
Account Profile settings for variations on basic payment process. Customization of
PayPal's payment pages. HTML
Details Instant Payment Notification (IPN) and Payment Data Transfer (PDT) for
automated receipt of payment information after payment completion. Details IPN
FORM variables and their meanings. Also includes information about
Details the use of the PayPal Software Development Kits for Java, Microsoft .NET,
Microsoft Classic ASP, and PHP to simplify use of the PayPal Web Services API.
26November 2005 Website Payments Standard Checkout Integration Guide
Using Your Merchant Account
2
Profile and Tools
This chapter details how you can use your account Profile settings and other tools on the
PayPal website to affect how payments are processed.
The Account Profile Summary
Use your PayPal account Profile to manage information about your PayPal account. To see
your Profile, log in to your PayPal account, and click the Profile subtab of the My Account
tab. The Profile has three sections: Account Information, Financial Information, and Selling
Preferences.
FIGURE 2.1 Account Profile Summary Page
Website Payments Standard Checkout Integration GuideNovember 200527
Using Your Merchant Account Profile and Tools
2
The Account Profile Summary
Account Information
Use the Account Information column for basic account maintenance, including updating
your password, adding and confirming email addresses, managing your business information,
and (for Premier accounts) configuring multi-user access to your PayPal account.
Financial Information
Use the Financial Information column to organize and maintain the financial instruments
associated with your PayPal account: manage your credit cards and bank accounts, activate
and manage your PayPal Debit Card, maintain multiple currency balances, and view your
monthly account statements.
Selling Preferences
Use the Selling Preferences column to organize the way you sell with your PayPal account,
including:
z Branding PayPal’s payment pages
z Streamlining purchases with Website Payment Preferences:
– Account Optional
–Auto Return
– Automatic calculation of shipping, handling, and sales tax
z Payment receiving preferences for blocking certain kinds of payments
z Getting customers’ contact telephone numbers
z Language encoding your data
The majority of this chapter focuses on using Selling Preferences.
Correspondence Between Profile Settings and HTML Variables
Many Profile settings have equivalent HTML FORM variables that can control the behavior of
individual transactions. After you enable a setting in your Profile, you can include FORM
variables with a transaction to take advantage of that Profile setting. See the following sections
for more information:
z “Overriding Page Style Settings On Individual Transactions” on page 33
z “Overriding Tax Setting on Individual Transactions” on page 46
z “Overriding Shipping Calculation on Individual Transactions” on page 46
z “Setting the Character Set: charset” on page 93
z “Setting Return URL on Individual Transactions” on page 93
z “Desired Currency on Individual Transactions” on page 93
28November 2005 Website Payments Standard Checkout Integration Guide
Using Your Merchant Account Profile and Tools
Branding PayPal’s Payment Pages
With our Custom Payment Pages feature, you can tailor PayPal’s payment pages to the style of
your website. Custom Payment Pages work with all PayPal Website Payment buttons and with
the PayPal Account Optional feature.
You can add up to three custom page styles.
The pictures in this section demonstrate the types of customization you can add to your PayPal
Website Payment buttons. Figure 2.2, “Uncustomized Payment Page in Standard PayPal Page
Style,” shows a payment page with no customization.
FIGURE 2.2Uncustomized Payment Page in Standard PayPal Page Style
Branding PayPal’s Payment Pages
2
Website Payments Standard Checkout Integration GuideNovember 200529
Using Your Merchant Account Profile and Tools
2
Branding PayPal’s Payment Pages
Figure 2.3, “Complete Custom Page Style,” shows all the customization you can make.
FIGURE 2.3Complete Custom Page Style
Page header imagePage header border colorPage header background color
Page background color
30November 2005 Website Payments Standard Checkout Integration Guide
Loading...
+ 86 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.