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 401
Index
A
AcceptFilters response field 68, 151, 271
Action request field 181, 215
ActivationDetails request field 192
ActivationDetailsType request fields 195
AdditionalBilling Cycles request field 223
Address Owner response field 171, 213
Address request field 59, 77, 88, 198, 229
Address response field 117, 170, 213, 241, 248
AddressOverride request field 89
AddressStatus response field 118, 171, 209, 214, 242
AddressType (Shipping) request fields 65, 94, 131, 196,
225, 256
AddressType (Shipping) response fields 118
AddressType request fields 60, 77, 199, 229
AddressType response fields 171, 209, 213, 242
AddressVerify API operation 27
AddressVerify request fields 27
AddressVerify request message 27
AddressVerify response fields 29
AddressVerify response message 28
AggregateAmount response field 208
AggregateOptionalAmount response field 208
AllowedPaymentMethod request field 102
AllowedPaymentMethodType request field 98, 122,
135
AllowNote request field 88
AllowPushFunding request field 102
American Express AVS response codes 381
American Express CVV2 response codes 383
Amount request field 32, 40, 44, 64, 73, 99, 137, 200,
217, 224, 259, 275, 393, 394, 395
Amount response field 41, 68, 78, 123, 178, 179, 211
Auction response field 177
AuctionInfoType response fields 178
AuctionItemNumber request field 283
AuctionTransaction Id request field 65, 101, 138, 260
AuctionTransaction Id response field 124
AUD 377, 378
Australian Dollar 377, 378
Authorization and Capture API Operation Reference 31
AuthorizationID request field 32, 44, 48
AuthorizationID response field 35, 45, 49
AuthorizationType response fields 42, 46
AuthStatus3ds request field 66
AutoBillOutstandingAmount request field 192, 224
AutoBillOutstandingAmount response field 208
AVS and CVV2 response codes 381
AVS response codes 381
AVSCode response field 68, 266
B
Balance response field 154
BalanceHoldings response field 154
BalanceTimeStamp response field 154
BanktxnPendingURL request field 92
BAUpdate API operation 243
BAUpdate request fields 243
BAUpdate request message 243
BAUpdate response fields 246
BAUpdate response message 244
BillingAgreement Details request field 92, 231
BillingAgreementCustom request field 104, 235, 244
BillingAgreementCustom response field 247
BillingAgreementDescription request field 104, 235,
244
BillingAgreementDescription response field 246
BillingAgreementDetails request fields 103, 234
BillingAgreementID response field 144, 237, 266
BillingAgreementMax response field 247
BillingAgreementStatus request field 243
BillingAgreementStatus response field 247
BillingFrequency response field 210
BillingPeriod response field 210
BillingPeriodDetailsType request fields 193, 226
BillingPeriodDetailsType response fields 210
BillingStartdate request field 191, 225
BillingStartdate response field 209
BillingType request field 103, 234
BillingType response field 246
BillOutstanding API operation 216