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
Index
408 February 01, 2013 SOAP API Developer Reference
RiskFilterListType response fields 69, 152, 272
S
SalesTax response field 176
Salutation request field 60, 76, 198, 262, 284
Salutation response field 170, 241, 248
ScheduleDetails request field 191
ScheduleDetailsType request fields 192
SecureMerchantAccountID response field 151
security 17
SEK 377, 379
SellerDetails request field 98, 135
SellerDetails response field 150
SellerDetailsType request fields 139
SellerID request field 139
SellerRegistrationDate request field 139
SellerUserName request field 139
service architecture 15
service endpoints 18
SetCustomerBillingAgreement API operation 231
SetCustomerBillingAgreement request fields 231
SetCustomerBillingAgreement request message 231
SetCustomerBillingAgreement response fields 236
SetCustomerBillingAgreement response message 235
SetExpressCheckout API operation 79
SetExpressCheckout request message 79
SetExpressCheckout response fields 105
SetExpressCheckout response message 105
SettleAmount response field 146, 173, 268
SeverityCode response field 126, 151
SGD 377, 378
Sheqel 377
Shipp ingDiscountrequest field 133
ShippingAmount request field 74, 224, 227
ShippingAmount response field 211
ShippingCalculationMode response field 124, 150, 166
ShippingDiscount request field 62, 96
ShippingDiscount response field 120
ShippingOptionAmount request field 103, 139
ShippingOptionAmount response field 125, 150, 167
ShippingOptionIsDefault request field 103, 139
ShippingOptionIsDefault response field 125, 150, 167
ShippingOptionName request field 103, 139
ShippingOptionName response field 125, 150, 167
ShippingOptionsType request fields 103
ShippingTotal request fie ld 257
ShippingTotal request field 61, 96, 133
ShippingTotal response field 119
ShipToAddress request field 63, 98, 135, 259
ShipToAddress response field 122
ShortMessage response field 126, 150
Singapore Dollar 377, 378
SOAP API definitions 16
SOAP request envelope 18
SoftDescriptor request field 33, 135, 255
SolutionType request field 92
StartDate request field 282, 283
StartMonth request field 58, 75, 197, 228, 261
StartMonth response field 213
StartYear request fie ld 59, 76, 197, 228, 262
StartYear response field 213
Stat eOrProvince response field 249
state and proivince codes 373
StateOrProvince request field 60, 65, 77, 95, 131, 196,
199, 226, 229, 256
StateOrProvince respon se field 118
StateOrProvince response field 171, 210, 214, 242
Status request field 284
Status response field 182, 286
StoreId 149, 176, 271
StoreID request field 34, 276, 388, 389
Street request field 28
Street1 request field 60, 65, 77, 94, 131, 196, 199, 225,
229, 256
Street1 response field 118, 171, 209, 214, 242, 248
Street2 request field 60, 65, 77, 94, 131, 196, 199, 225,
229, 256
Street2 response field 118, 171, 209, 214, 242, 249
StreetMatch response field 29
SubscriberName request field 191, 223
SubscriberName response field 209
SubscriberShipping Address request field 191, 223
SubscriberShipping Address response field 209
Subscription response field 177
SubscriptionDate response field 178
SubscriptionID response field 178, 179
SubscriptionInfoType response fields 178
SubscriptionTermsType response field 179
SubscriptionTermsType response fields 179
SuccessPageRedirectRequested response field 144
Suffix request field 60
Suffix requestfield 76, 199, 262, 284
Suffix response field 117, 170, 242, 248