Sandbox User Guide
For Professional Use Only
Currently only available in English.
A usage Professional Uniquement
Disponible en Anglais uniquement pour l'instant.
Last Updated: June 2006
PayPal Sandbox User Guide
© 2006 PayPal Inc. All rights reserved. PayPal and the PayPal logo are registered trademarks of PayPal Inc. Other trademarks and brands are the
property of their respective owners.
The information in this document belongs to PayPal Inc. It may not be used, reproduced or disclosed without the written approval of PayPal Inc.
PayPal (Europe) Ltd. is authorised and regulated by the Financial Services Authority in the United Kingdom as an electronic money institution.
PayPal FSA Register Number: 226056.
Notice of non-liability:
PayPal Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal Inc. makes no warranties of any kind (whether express,
implied or statutory) with respect to the information contained herein. PayPal Inc. assumes no liability for damages (whether direct or indirect), caused
by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting f rom the application or use
of the product or service described herein. PayPal Inc. reserves the right to make changes to any information herein without further notice.
PayPal Inc. does not guarantee that the features described in this document will be announced or made available to anyone in the future.
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Organization of This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 1 Overview to the PayPal Sandbox . . . . . . . . . . . . . . 13
Get Started Quickly: Integration Center . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
At a Glance: Differences between the Sandbox and Live PayPal . . . . . . . . . . . . . . 13
Chapter 2 Accessing the PayPal Sandbox and Email . . . . . . . . .17
Signing Up for Developer Central . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Getting to the Sandbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Accessing the Sandbox Directly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Launching the Sandbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Managing Your Developer Central Profile . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Sandbox Email. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 3 Setting up Test Users . . . . . . . . . . . . . . . . . . . . 21
Planning the Types of Test Accounts You Need . . . . . . . . . . . . . . . . . . . . . . . 21
Managing Test Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Creating a Personal Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Creating a Business Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Confirming an Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
“Unverified” Account Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Adding a Bank Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
For Canada, Germany, or UK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Steps for All Countries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Adding a Credit Card Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Adding a Credit Card for a New Test User. . . . . . . . . . . . . . . . . . . . . . . . 25
Adding More Credit Cards for an Existing Test User . . . . . . . . . . . . . . . . . . 25
June 2006 3
Contents
Generating a Credit Card Number to Test PayPal Account Optional . . . . . . . . . . 26
Signing Up for Website Payments Pro. . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Chapter 4 Testing PayPal Website Features . . . . . . . . . . . . . .27
Website Payments with Buy Now Button . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Encrypted Website Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Testing Payments with Buy Now Button . . . . . . . . . . . . . . . . . . . . . . . . . 28
Verifying a Test Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Instant Payment Notification (IPN). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting up IPN in the Sandbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Verifying a Test Refund . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Transferring Funds to a Test Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Clearing or Failing Test eCheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . 30
Sending Funds to a Seller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Billing A Customer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 5 Testing PayPal Web Services API Applications . . . . . . .33
PayPal WSDL/XSD Schema Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Requesting API Credentials from PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . 34
To get a Sandbox certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
To get a live PayPal certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Testing with the PayPal SDK Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
API Overview By Business Function and Service Endpoint . . . . . . . . . . . . . . . . . 35
Chapter 6 Technical Support . . . . . . . . . . . . . . . . . . . . . .37
Contacting Customer Service for Live PayPal Website Help . . . . . . . . . . . . . . . . 37
Contacting Developer Technical Support for API Help. . . . . . . . . . . . . . . . . . . . 37
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
4 June 2006
List of Tables
Table P.1 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Table 1.1 Differences between Developer Central, Sandbox, and Live PayPal . . . 13
Table 3.1 German, Canadian, and UK Test Bank Account Information . . . . . . . 24
Table 5.1 Location of PayPal WSDL and XSD Files . . . . . . . . . . . . . . . . . 33
Table 5.2 API Overview by Business Function and Service Endpoint . . . . . . . . 35
June 2006 5
List of Tables
6 June 2006
List of Figures
Figure 2.1 Login for PayPal Developer Central . . . . . . . . . . . . . . 18
Figure 2.2 Sandbox Email Client . . . . . . . . . . . . . . . . . . . . 19
June 2006 7
List of Figures
8 June 2006
Preface
This Document
This document, which describes the PayPal virtual test environment called the Sandbox,
replaces the PayPal Sandbox User Guide issued December, 2005.
Intended Audience
This document is written for merchants and developers who want to test their PayPal-based
applications before using them in production.
Organization of This Document
Chapter 1, “Overview to the PayPal Sandbox,” describes the Sandbox in general and lists the
differences between the Sandbox and the production PayPal services.
Chapter 2, “Accessing the PayPal Sandbox and Email,” describes how to gain access to the
Sandbox and your Sandbox email.
Chapter 3, “Setting up Test Users,” describes the different kinds of business roles and
corresponding test accounts you need to set up on the Sa ndbox for effective testing of your
PayPal-based applications.
Chapter 4, “Testing PayPal Website Features,” describes how you can use the Sandbox
(
https://www.sandbox.paypal.com) to test features that correspond to the features on the main
PayPal interactive site
Chapter 5, “Testing PayPal Web Services API Applications,” is an overview of testing PayPal
Web Services API applications with the Sandbox, API digital certificates, and other related
information.
https://www.paypal.com/.
Notational Conventions
This document uses typefaces to identify the characteristics of text. These typefaces and the
characteristics they imply are described below:
June 2006 9
Preface
Revision History
Typeface How Used
serif italics A document title.
monospaced Pathnames or file names that appear in body text frames.
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.
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 bold User interface names, such as window names or menu selections.
San-serif
oblique
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 attribute How Used
xxxxxx Hypertext link to a page in the current document or to another document in the set.
xxxxxx
Revision History
For example: On the Profile page, click Email to confirm your email address.
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.
Hypertext link to a URL or that initiates a web action, such as sending mail.
X is the name of the variable for a multi-item shopping cart. amount_3
Revision history for PayPal Sandbox User Guide.
10 June 2006
Preface
Revision History
TABLE P.1 Revision History
Date Description
June 2006 Correction of Sort Code necessary to test UK accounts in Sandbox. Proper Sort
Code is 609204.
December 2005 Miscellaneous corrections.
June 2006 11
Preface
Revision History
12 June 2006
Loading...