2012
Table Of Contents
- SOAP API Developer Reference
- Contents
- What’s New
- Preface
- 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
- ManagePendingTransactionStatus 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
- Revision History
- Index
SOAP API Developer Reference August 2012 397
Index
PaymentTransactionDetails response field 168
PaymentTransactionDetails response fields 170
PaymentType request field 104, 237
PaymentType response field 145, 174, 269
PayPalAccountID request field 101
PayPalAccountID response field 125, 152
PayPalAdjustment response field 115
PayPalToken response field 29
PendingFilters response field 68, 152, 273
PendingReason request field 280
PendingReason response field 43, 47, 148, 177, 272
Period response field 181
Peso 369
Philippine Peso 369
Phone request field 61, 66, 77, 95, 131, 198, 201, 228,
231, 258
Phone response field 118, 173, 216
PHP 369
PLN 369, 370
Polish Zloty 369, 370
PostalCode re sponse field 118
PostalCode request field 61, 65, 77, 95, 130, 198, 201,
228, 231, 258
PostalCode response field 173, 212, 216, 244, 251
Pound Sterling 369, 370
previous versions 375
ProfileID request field 204, 217, 219, 225, 284
ProfileID response field 203, 209, 218, 220, 232
ProfileReference request field 193, 225
ProfileReference response field 211
ProfileStatus response field 203, 209
ProtectionEligibility response field 43, 47, 149, 178,
273
ProtectionEligibilityType response field 44, 48, 150,
178, 273
Q
Quantity request field 64, 100, 136, 202, 262, 382, 383,
385
Quantity response field 123, 179
R
ReasonCode response field 149, 177, 272
reattempt response field 181
ReceiptID request field 282
ReceiptID response field 174, 269
Receiver request field 282
Receiver response field 171
ReceiverEmail request field 74
ReceiverID response field 171
ReceiverInfo response field 170
ReceiverInfoType response fields 171
ReceiverType request field 186
Recurrences response field 181
Recurring Payments API Operations 187
Recurring request field 63, 261, 379
recurring response field 181
RecurringPayments ProfileDetails response field 210
RecurringPayments Summary response field 210
RecurringPaymentsProfileDetails request field 193
RecurringPaymentsProfileDetailsType request
fields 193
RecurringPaymentsProfileDetailsType response
fields 211
RecurringPaymentsSummaryDetailsType response
fields 213
RedirectRequired response field 115, 142
Reference Transactions API Operations 187
ReferenceID request field 245, 255
RefundAdvice request field 277
RefundInfo request field 279
RefundItemDetails request field 277
RefundSource request field 277
RefundStatus request field 280
RefundTransaction API operation 275
RefundTransaction request fields 276
RefundTransaction request message 275
RefundTransaction response fields 278
RefundTransaction response message 278
RefundTransactionID response field 278
RefundType request field 276, 378
ReportsFilters response field 69, 152, 273
ReqConfirmShipping request field 88, 256
request structure 19
RequesterCredentials 17
response structure 21
RetryTime response field 180
RetryUntil request field 276
ReturnAllCurrencies request field 155
ReturnFMFDetails request field 57, 129, 256
ReturnURL request field 87, 234
RiskFilterListType response fields 69, 153, 274