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 409
Index
SurveyChoice request field 94
SurveyChoiceSelected request field 131
SurveyChoiceSelected response field 116, 168
SurveyEnable request field 94
SurveyQuestion request field 94, 131
SurveyQuestion response field 116
SurveyQuestionresponse field 168
Swedish Krona 377, 379
Swiss Franc 378, 379
T
Taiwan New Dollar 378
Tax request field 64, 100, 137, 201, 260, 393
Tax response field 123
TaxAmount request field 74, 195, 224, 227
TaxAmount response field 146, 173, 211, 268
TaxId request field 104
TaxId response field 126
TaxIdDetails request field 102
TaxIdDetailsType request fields 104
TaxIdDetailsType response fields 126
TaxIdType request field 104
TaxIdType response field 126
TaxTotal request field 62, 97, 134, 258
TaxTotal response field 121
TerminalId 149, 176, 271
TerminalID response field 34, 276, 388, 389
Thai Baht 378
THB 378
ThreeDSecure request fields 66
ThreeDSecure response fields 70
ThreeDSecureRequest request field 57
Timestamp response field 285
Timezone response field 286
Token request field 106, 129, 190, 237, 238
Token response field 105, 114, 143, 236
TotalBillingCycles response field 210
TotalRefundedAmount response field 278
TPLReferenceID response field 168
TransactionClass request field 283
TransactionEntity request field 40
TransactionID request field 40, 159, 181, 274, 275, 282
TransactionId request field 98, 135
TransactionID response field 41, 68, 78, 145, 172, 182,
266, 286
TransactionId response field 122, 125
TransactionSearch API operation 281
TransactionSearch request fields 282
TransactionSearch request message 281
TransactionSearch response fields 285
TransactionSearch response message 285
TransactionTyp eresponse field 146
TransactionType response field 172, 267
TrialPeriod request field 192, 225
TrialPeriod.Amount request field 194, 227
TrialPeriod.BillingFrequency request field 194
TrialPeriod.BillingPeriod request field 194
TrialPeriod.TotalBillingCycles request field 194, 226
TRY 378
Turkish Lira 378
TWD 378
Type response field 286
U
U.S. Dollar 378, 379
UpdateRecurringPaymentsProfile API operation 218
UpdateRecurringPaymentsProfile request fields 223
UpdateRecurringPaymentsProfile request message 219
UpdateRecurringPaymentsProfile response fields 230
UpdateRecurringPaymentsProfile response
message 230
USD 378, 379
UserName response field 179
UserSelectedOptions request field 130
UserSelectedOptions response field 115
UserSelectedOptions response fields 124, 150
V
Visa AVS response codes 381
Visa CVV2 response codes 383
VPAS response field 70
W
WSDL/XSD schema definitions 16
X
XID request field 66