Download PayPal Web Services API - 2006 Reference Manual

Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Organization of This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Documentation Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 1
Overview of the PayPal Web Services API . . . . . . . . . 17
Get Started Quickly: Integration Center . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Complementary Technical Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Open Standards Background Information . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Web Services Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Cryptography. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 2
PayPal Web Services API Architecture . . . . . . . . . . . 21
Services Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
PayPal WSDL/XSD Schema Definitions. . . . . . . . . . . . . . . . . . . . . . . . . 22
API Concepts and Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
SOAP RequesterCredentials: Username, Password, Signature, and Subject . . . . . 24
Public/Private Key Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
SSL Data Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
SOAP Service Endpoints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
SOAP Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
SOAP Message Style: doc-literal . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
SOAP Request Envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Request Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Response Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Error Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
CorrelationID for Reporting Problems to PayPal . . . . . . . . . . . . . . . . . . . . 30
Test Tools: PayPal SDK Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Web Services API Reference
July 2006
3