2013
Table Of Contents
- SOAP API Developer Reference
- Contents
- PayPal SOAP API Basics
- PayPal WSDL/XSD Schema Definitions
- PayPal SOAP API Definitions
- Security
- SOAP RequesterCredentials: Username, Password, Signature, and Subject
- SOAP Service Endpoints
- SOAP Request Envelope
- Request Structure
- SOAP Message Style: doc-literal
- Response Structure
- Error Responses
- CorrelationID for Reporting Problems to PayPal
- UTF-8 Character Encoding
- Date/Time Formats
- Core Currency Amount Data Type
- AddressVerify API Operation
- Authorization and Capture API Operation Reference
- DoDirectPayment API Operation
- DoNonReferencedCredit API Operation
- ExpressCheckout API Operations
- GetBalance API Operation
- GetPalDetails API Operation
- GetTransactionDetails API Operation
- ManagePendingTransactionStatu s API Operation
- MassPay API Operation
- Recurring Payments and Reference Transactions API Operations
- CreateRecurringPaymentsProfile API Operation
- GetRecurringPaymentsProfileDetails API Operation
- ManageRecurringPaymentsProfileStatus API Operation
- BillOutstandingAmount API Operation
- UpdateRecurringPaymentsProfile API Operation
- SetCustomerBillingAgreement API Operation
- CreateBillingAgreement API Operation
- GetBillingAgreementCustomerDetails API Operation
- BAUpdate API Operation
- DoReferenceTransaction API Operation
- RefundTransaction API Operation
- TransactionSearch API Operation
- API Error Codes
- General API Errors
- Validation Errors
- DirectPayment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- MassPay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Countries and Regions Supported by PayPal
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
- About Previous Versions of the API
- What’s New in Version 95.0
- What’s New in Version 93.0
- What’s New in Version 92.0
- What’s New in Version 91.0
- What’s New in Version 89.0
- What’s New in Version 88.0
- What’s New in Version 85.0
- What’s New in Version 84.0
- What’s New in Version 82.0
- What’s New in Version 80.0
- What’s New in Version 74.0
- What’s New in Version 72.0
- What’s New in Version 69
- What’s New in Version 66
- Revision History
- Index
SOAP API Developer Reference February 01, 2013 407
Index
PaymentTransactionDetails response field 166
PaymentTransactionDetails response fields 168
PaymentType request field 104, 235, 254
PaymentType response field 146, 172, 267
PayPalAccountID request field 101
PayPalAccountID response field 125, 151
PayPalAdjustment response field 115
PayPalToken response field 29
PendingFilters response field 69, 151, 271
PendingReason request field 279
PendingReason response field 43, 47, 148, 175, 270
Period response field 179
Peso 377
Philippine Peso 377
Phone request field 61, 66, 77, 95, 132, 196, 199, 226,
230, 256
Phone response field 118, 171, 214
PHP 377
PLN 377, 378
Polish Zloty 377, 378
Postal Code response field 171, 214
PostalCode re sponse field 118
PostalCode request field 61, 65, 77, 95, 131, 196, 199,
226, 230, 256
PostalCode response field 210, 242, 249
Pound Sterling 377, 378
previous versions 385
ProfileID request field 202, 215, 217, 223, 284
ProfileID response field 201, 207, 216, 218, 230
ProfileReference request field 191, 223
ProfileReference response field 209
ProfileStatus response field 201, 207
ProtectionEligibility response field 43, 47, 149, 176,
271
ProtectionEligibilityType response field 44, 48, 149,
176, 271
Q
Quantity request field 64, 100, 137, 200, 260, 393, 394,
395
Quantity response field 123, 177
R
ReasonCode response field 148, 175, 270
reattempt response field 179
ReceiptID request field 282
ReceiptID response field 172, 267
Receiver request field 282
Receiver response field 169
ReceiverEmail request field 74
ReceiverID response field 169
ReceiverInfo response field 168
ReceiverInfoType response fields 169
ReceiverType request field 184
Recurrences response field 179
Recurring Payments API Operations 185
Recurring request field 63, 259, 389, 390
recurring response field 179
RecurringPayments ProfileDetails response field 208
RecurringPayments Summary response field 208
RecurringPaymentsProfileDetails request field 191
RecurringPaymentsProfileDetailsType request
fields 191
RecurringPaymentsProfileDetailsType response
fields 209
RecurringPaymentsSummaryDetailsType response
fields 211
RedirectRequired response field 115, 143
Reference Transactions API Operations 185
ReferenceID request field 243, 253
RefundAdvice request field 276
RefundInfo request field 278
RefundItemDetails request field 276
RefundSource request field 275
RefundStatus request field 279
RefundTransaction API operation 273
RefundTransaction request fields 274
RefundTransaction request message 273
RefundTransaction response fields 277
RefundTransaction response message 277
RefundTransactionID response field 277
RefundType request field 275, 389
ReportsFilters response field 69, 151, 271
ReqConfirmShipping request field 88, 254
request structure 19
RequesterCredentials 17
response structure 21
RetryTime response field 178
RetryUntil request field 275
ReturnAllCurrencies request field 153
ReturnFMFDetails request field 57, 130, 254
ReturnURL request field 87, 232