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
404 February 01, 2013 SOAP API Developer Reference
FirstName response field 117, 170, 213, 241, 248
FlatR ateShippingOptions request field 88
FMFDetails response field 68, 144, 150, 266
FMFDetailsType response fields 68, 151, 271
Forint 377, 378
FulfillmentAddress 98
FulfillmentAddress field 121, 122
FundingSourceDetails request field 93
FundingSourceDetailsType request fields 102
G
GBP 377, 378
Get ExpressCheckout Details request fields 106
GetBalance API operation 153
GetBalance request fields 153
GetBalance request message 153
GetBalance response fields 154
GetBalance response message 154
GetBillingAgreementCustomerDetails API
operation 238
GetBillingAgreementCustomerDetails request
fields 238
GetBillingAgreementCustomerDetails request
message 238
GetBillingAgreementCustomerDetails response
fields 240
GetBillingAgreementCustomerDetails response
message 239
GetExpressCheckoutDetails API operation 105
GetExpressCheckoutDetails request message 106
GetExpressCheckoutDetails response fields 114
GetExpressCheckoutDetails response message 107
GetPalDetails API operation 155
GetPalDetails request message 155
GetPalDetails response fields 156
GetPalDetails response message 156
GetRecurringPaymentsProfileDetails API
operation 202
GetRecurringPaymentsProfileDetails request fields 202
GetRecurringPaymentsProfileDetails request
message 202
GetRecurringPaymentsProfileDetails response
fields 207
GetRecurringPaymentsProfileDetails response
message 203
GetTransactionDetails API operation 159
GetTransactionDetails request fields 159
GetTransactionDetails request message 159
GetTransactionDetails response fields 166
GetTransactionDetails response message 160
GiftMessage requ est field 130
GiftMessage response field 115, 167
GiftMessageEnable request field 93
GiftReceiptEnable request field 93, 130
GiftReceiptEnable response field 116, 167
GiftWrapAmount request field 93, 130
GiftWrapAmount response field 116, 168
GiftWrapEnable request field 93
GiftWrapName request field 93, 130
GiftWrapName response field 116, 167
giropayCancelURL request field 92
giropaySuccessURL requ est field 92
GrossAmount response field 146, 173, 267, 286
GrossRefundAmount response field 278
H
HandlingTotal request field 62, 97, 133, 257
HandlingTotal response field 120
HKD 377
HoldDecision response field 149
Hong Kong Dollar 377
HUF 377, 378
Hungarian Forint 377, 378
I
ID response field 69, 152, 272
ILS 377
InitialAmount request field 195
InsuranceOp tion Offered response field 120
InsuranceOptionOffered request field 97, 133
InsuranceOptionSelected request field 139
InsuranceOptionSelected response field 124, 150, 167
InsuranceTotal request field 62, 96, 133
InsuranceTotal response field 120
InvoiceID request field 32, 63, 87, 98, 134, 258, 275,
282
InvoiceID response field 114, 176
InvoiceID responsefield 121
IPAddress request field 57, 254
Israeli Sheqel 377
IssueNumber request field 59, 76, 198, 229, 262
IssueNumber response field 213