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 391
Index
A
AcceptFilters response field 68, 152, 273
Action request field 183, 217
ActivationDetails request field 194
ActivationDetailsType request fields 197
AdditionalBilling Cycles request field 225
Address Owner response field 172, 215
Address request field 59, 77, 88, 200, 231
Address response field 117, 172, 215, 243, 250
AddressOverride request field 89
AddressStatus response field 118, 172, 211, 216, 244
AddressType (Shipping) request fields 65, 95, 130, 198,
227, 258
AddressType (Shipping) response fields 118
AddressType request fields 60, 77, 201, 231
AddressType response fields 172, 211, 215, 244
AddressVerify API operation 27
AddressVerify request fields 27
AddressVerify request message 27
AddressVerify response fields 29
AddressVerify response message 28
AggregateAmount response field 210
AggregateOptionalAmount response field 210
AllowedPaymentMethod request field 102
AllowedPaymentMethodType request field 98, 122,
134
AllowNote request field 88
AllowPushFunding request field 102
American Express AVS response codes 371
American Express CVV2 response codes 373
Amount request field 32, 40, 45, 64, 73, 99, 136, 202,
220, 226, 261, 276, 382, 383, 385
Amount response field 41, 68, 78, 122, 180, 181, 213
Auction response field 179
AuctionInfoType response fields 180
AuctionItemNumber request field 283
AuctionTransaction Id request field 65, 101, 137, 262
AuctionTransaction Id response field 124
AUD 369, 370
Australian Dollar 369, 370
Authorization and Capture API Operation Reference 31
AuthorizationID request field 32, 45, 49
AuthorizationID response field 35, 45, 50
AuthorizationType response fields 42, 46
AuthStatus3ds request field 66
AutoBillOutstandingAmount request field 194, 226
AutoBillOutstandingAmount response field 210
AVS and CVV2 response codes 371
AVS response codes 371
AVSCode response field 68, 268
B
Balance response field 156
BalanceHoldings response field 156
BalanceTimeStamp response field 156
BanktxnPendingURL request field 92
BAUpdate API operation 245
BAUpdate request fields 245
BAUpdate request message 245
BAUpdate response fields 248
BAUpdate response message 246
BillingAgreement Details request field 92, 233
BillingAgreementCustom request field 104, 237, 246
BillingAgreementCustom response field 249
BillingAgreementDescription request field 104, 237,
246
BillingAgreementDescription response field 248
BillingAgreementDetails request fields 103, 236
BillingAgreementID response field 143, 239, 268
BillingAgreementMax response field 249
BillingAgreementStatus request field 245
BillingAgreementStatus response field 249
BillingFrequency response field 212
BillingPeriod response field 212
BillingPeriodDetailsType request fields 195, 228
BillingPeriodDetailsType response fields 212
BillingStartdate request field 193, 227
BillingStartdate response field 211
BillingType request field 103, 236
BillingType response field 248
BillOutstanding API operation 219