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
402 February 01, 2013 SOAP API Developer Reference
BillOutstandingAmount request fields 217
BillOutstandingAmount request message 217
BillOutstandingAmount response fields 218
BillOutstandingAmount response message 218
BrandName request field 93
Brazilian Real 377
BRL 377
Business response field 169
ButtonSource request field 63, 131, 134, 258
BuyerDetails request field 93
BuyerDetailsType request fields 102
BuyerEmail request field 91, 234
BuyerEmailOptinEnable request field 94
BuyerId request field 102
BuyerID response field 178
BuyerMarketingEmail request field 130
BuyerMarketingEmail response field 116, 168
BuyerRegistrationDate request field 102
BuyerUserName request field 102
C
CAD 377, 378
CallbackTimeout request field 87
CallbackURL request field 87
Canadian Dollar 377, 378
CancelURL request field 87, 232
CardNumber request field 282
CardOwner request field 58, 75, 197, 228, 261
CardOwner response field 213
CartID request field 101, 138
CartID response field 124
Cavv request field 66
ChannelType request field 92
character encoding 24
CheckoutStatus response field 115
CHF 378, 379
CityName request field 60, 77, 199, 229
CityName response field 171, 209, 214, 242, 249
ClosingDate response field 178
Comment request field 74
CompleteType request field 32
ConfirmationCode response field 29
ContactPhone response field 115
CorrelationID 24
Country request field 60, 66, 77, 95, 131, 196, 199,
226, 230, 256
Country response field 118, 171, 210, 214, 242, 249
CountryCode response field 29
CountryCodeType 66, 95, 118, 131, 196, 226, 256
CountryName response field 171, 214
CouponAmount response field 177
CouponAmountCurrency 177
CouponID 177
cpp-header-back-color request field 91, 234
cpp-header-border request field 234
cpp-header-border-color request field 91
cpp-header-image request field 91, 234
cpp-payflow-color request field 91, 234
CreateBillingAgreement API operation 236
CreateBillingAgreement request fields 237
CreateBillingAgreement request message 236
CreateBillingAgreement response fields 237
CreateBillingAgreement response message 237
CreateRecurringPaymentsProfile API operation 185
CreateRecurringPaymentsProfile request fields 190
CreateRecurringPaymentsProfile request message 185
CreateRecurringPaymentsProfile response fields 201
CreateRecurringPaymentsProfile response
message 201
CreditCard request field 57, 74, 191, 225
CreditCard response field 208
CreditCardDetailsType request fields 58, 75, 197, 228,
261
CreditCardDetailsType response fields 212
CreditCardNumber request field 58, 75, 197, 228, 261
CreditCardNumber response field 212
CreditCardType request field 58, 75, 197, 228, 261
CreditCardType response field 212
currencies 24
currency codes 377, 378
CurrencyCode request field 283
CurrentRecurring PaymentsPeriod response field 208
Custom requ est field 63
Custom request field 87, 97, 134, 258
Custom response field 114, 121, 176
CustomerServiceNumber request field 93
CVV2 request field 58, 75, 197, 228, 261
CVV2 response codes 383
CVV2Code response field 68, 266
Czech Koruna 377, 378
CZK 377, 378