Table of Contents Previous Next Index

Table of Contents

SOAP API Developer Reference
PayPal SOAP API Architecture
Services Architecture
PayPal WSDL/XSD Schema Definitions
API Concepts and Terminology
Security
SOAP RequesterCredentials: Username, Password, Signature, and Subject
SOAP Service Endpoints
SOAP Implementation
SOAP Message Style: doc-literal
SOAP Request Envelope
Request Structure
Response Structure
Error Responses
CorrelationID for Reporting Problems to PayPal
PayPal SOAP API Definitions
Character Encoding, Data Types and Formats, and Currencies
API Overview By Business Function
Instant Payment Notification and the APIs
Core eBL Request/Response Structures
Diagram of core eBL Types
AbstractRequestType
AbstractResponseType
Authorization & Capture API
DoCapture
Diagram of DoCapture Types
DoCaptureRequest
DoCaptureResponse
DoAuthorization
Diagram of DoAuthorization Types
DoAuthorizationRequest
DoAuthorizationResponse
DoVoid
Diagram of DoVoid Types
DoVoidRequest
DoVoidResponse
DoReauthorization
Diagram of DoReauthorization Types
DoReauthorizationRequest
DoReauthorizationResponse
Direct Payment API
Diagram of DoDirectPayment Types
DoDirectPaymentRequest
DoDirectPaymentResponse
AVS Response Codes
CVV2 Response Codes
Express Checkout API
Express Checkout for eBay Auctions
SetExpressCheckout
Diagram of Set ExpressCheckout Types
SetExpressCheckoutRequest
SetExpressCheckoutResponse
GetExpressCheckoutDetails
Diagram of GetExpressCheckoutDetails Types
GetExpressCheckoutDetailsRequest
GetExpressCheckoutDetailsResponse
DoExpressCheckoutPayment
Diagram of DoExpressCheckoutPayment Types
DoExpressCheckoutPaymentRequest
DoExpressCheckoutPaymentResponse
GetTransactionDetails API
Diagram of GetTransactionDetails Types
GetTransactionDetailsRequest
GetTransactionDetailsResponse
MassPay API
Instant Payment Notification
Diagram of MassPay Types
MassPayRequest
MassPayResponse
RefundTransaction API
Diagram of RefundTransaction Types
RefundTransactionRequest
RefundTransactionResponse
TransactionSearch API
Diagram of TransactionSearch Types
TransactionSearchRequest
TransactionSearchResponse
Recurring Payments and Reference Transactions
CreateRecurringPaymentsProfile
Diagram of CreateRecurringPaymentsProfile Types
CreateRecurringPaymentsProfileRequest
CreateRecurringPaymentsProfileResponse
GetRecurringPaymentsProfileDetails
Diagram of GetRecurringPaymentsProfileDetails Types
GetRecurringPaymentsProfileDetails Request
GetRecurringPaymentsProfileDetails Response
ManageRecurringPaymentsProfileStatus
Diagram of ManageRecurringPaymentsProfileStatus Types
ManageRecurringPaymentsProfileStatus Request
ManageRecurringPaymentsProfileStatus Response
BillOutstandingAmount
Diagram of BillOutstandingAmount Types
BillOutstandingAmount Request
BillOutstandingAmount Response
UpdateRecurringPaymentsProfile
Diagram of UpdateRecurringPaymentsProfile Types
UpdateRecurringPaymentsProfile Request
UpdateRecurringPaymentsProfile Response
SetCustomerBillingAgreement
Diagram of SetCustomerBillingAgreement Types
SetCustomerBillingAgreementRequest
SetCustomerBillingAgreementResponse
GetBillingAgreementCustomerDetails
Diagram of GetBillingAgreementCustomerDetails Types
GetBillingAgreementCustomerDetailsRequest
GetBillingAgreementCustomerDetailsResponse
DoReferenceTransaction
DoReferenceTransactionRequest
DoReferenceTransactionResponse
Non-Referenced Credits API
Diagram of Non-Referenced Credit Types
DoNonReferencedCreditRequest
DoNonReferencedCreditResponse
Fraud Management Filters API
Fraud Management Filters API Prerequisites
ManagePendingTransactionStatus
ManagePendingTransactionStatus Request
ManagePendingTransactionStatus Response
Error Codes and Messages for All PayPal APIs
General API Errors
Authorization and Capture API Errors
Direct Payment API Errors
Express Checkout API Errors
GetTransactionDetails API Errors
MassPay API Errors
RefundTransaction API Errors
TransactionSearch API Errors
Recurring Payments and Reference Transactions API Errors
Recurring Payments Errors
SetCustomerBillingAgreement Errors
GetBillingAgreementCustomerDetails Errors
DoReferenceTransaction Errors
Fraud Management Filters API Errors
The Java SDK for the SOAP API
Installing the SDK
Supported Human Languages
SDK Version Number
Recommended Hardware Configuration
Download and Unzip the SDK
Post-installation Set-up
Adding SDK JAR Files to CLASSPATH
SDK Directories and Optional Configurations
SDK Logging
API Services
Profiles
Sample Applications
Sample API User with API Signature
Sample API User with API Certificate
Configuring ColdFusion for the PayPal Java SDK
Summary of Installation Steps
Samples of CFM Pages
Recopying JAR Files after WSDL Updates
The ASP.NET and Classic ASP SDKs for the SOAP API
Installing the SDK
Supported Standards
Downloading and Installing the SDK
SDK Directories
Uninstalling the SDK
Installing the Samples
Configuring the SDK
Referencing the SDK DLLs for ASP.NET
Modifying the Web.config File
Setting Maximum Retries of SOAP Requests
SDK Logging
Enabling Proxy Support for ASP.NET
API Services
Complete SDK and API Class Documentation
Profiles
Overview to Profile-related Classes
COM-Specific Classes
COMAdapter2
COMArray
COMUtil
Sample Applications
Sample API User with API Signature
Sample API User and Certificate
Installing the Samples in IIS
Running the Samples
The PHP SDK for the SOAP API
Configuring PHP and Apache for the SDK
Supported Standards
Supported Human Languages
SDK Version Number
Downloading and Installing the SDK
Installing on Local Computer
Installing on Remote Computer from Microsoft Windows
SDK Directories and Configuration Files
Configuration File
SDK Logging
API Services
Profiles
Overview to Profile-related Classes
Sample Applications
Sample API User with API Signature
Sample API User and Certificate
Running the Samples
State and Province Abbreviations
Country Codes