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
Index
392 August 2012 SOAP API Developer Reference
BillOutstandingAmount request fields 219
BillOutstandingAmount request message 219
BillOutstandingAmount response fields 220
BillOutstandingAmount response message 220
BrandName request field 93
Brazilian Real 369
BRL 369
Business response field 171
ButtonSource request field 63, 130, 133, 260
BuyerDetails request field 93
BuyerDetailsType request fields 102
BuyerEmail request field 91, 236
BuyerEmailOpti nEnable request field 94
BuyerId request field 102
BuyerID response field 180
BuyerMarketingEmail request field 129
BuyerMarketingEmail response field 116, 170
BuyerRegistrationDate request field 102
BuyerUserName request field 102
C
CAD 369, 370
CallbackTimeout request field 87
CallbackURL request field 87
Canadian Dollar 369, 370
CancelURL request field 87, 234
CardNumber request field 282
CardOwner request field 58, 75, 199, 230, 263
CardOwner response field 215
CartID request field 101, 137
CartID response field 124
Cavv request field 66
ChannelType request field 92
character encoding 24
CheckoutStatus response field 115
CHF 369, 370
CityName request field 60, 77, 201, 231
CityName response field 173, 211, 216, 244, 251
ClosingDate response field 180
Comment request field 74
CompleteType request f ield 32
ConfirmationCode response field 29
ContactPhone response field 115
CorrelationID 24
Country request field 60, 66, 77, 95, 130, 198, 201,
228, 231, 258
Country response field 118, 173, 212, 216, 244, 251
CountryCode response field 29
CountryCodeType 66, 95, 118, 130, 198, 228, 258
CountryName response field 173, 216
CouponAmount response field 179
CouponAmountCurrency 179
CouponID 179
cpp-header-back-color request field 91, 236
cpp-header-border request field 236
cpp-header-border-color request field 91
cpp-header-image request field 91, 236
cpp-payflow-color request field 91, 236
CreateBillingAgreement API operation 238
CreateBillingAgreement request fields 238
CreateBillingAgreement request message 238
CreateBillingAgreement response fields 239
CreateBillingAgreement response message 239
CreateRecurringPaymentsProfile API operation 187
CreateRecurringPaymentsProfile request fields 192
CreateRecurringPaymentsProfile request message 187
CreateRecurringPaymentsProfile response fields 203
CreateRecurringPaymentsProfile response
message 203
CreditCard request field 57, 74, 193, 227
CreditCard response field 210
CreditCardDetailsType request fields 58, 75, 199, 229,
263
CreditCardDetailsType response fields 214
CreditCardNumber request field 58, 75, 199, 230, 263
CreditCardNumber response field 214
CreditCardType request field 58, 75, 199, 229, 263
CreditCardType response field 214
currencies 24
currency codes 369, 370
CurrencyCode request field 283
CurrentRecurring PaymentsPeriod response field 210
Custom request field 63, 87, 98, 133, 260
Custom response field 114, 121, 178
CustomerServiceNumber request field 93
CVV2 request field 58, 75, 199, 230, 263
CVV2 response codes 373
CVV2Code response field 68, 268
Czech Koruna 369, 370
CZK 369, 370