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
406 February 01, 2013 SOAP API Developer Reference
Name response field 69, 118, 122, 152, 171, 177, 209,
214, 242, 248, 272
NetAmount request field 74
NetAmount response field 286
NetRefundAmount response field 278
New Zealand Dollar 377, 378
NextBillingDate response field 211
NOK 377, 378
Norwegian Krone 377, 378
NoShipping request field 88
Note request field 32, 49, 215, 218, 223
Note response field 115, 143
NoteT ext request field 98
NoteText request field 135
NoteText response field 122
Noti fyURL request field 63
NotifyURL request field 98, 135, 258
NotifyURL response field 121
Number request field 64, 100, 137, 200, 260, 393
Number response field 123, 177
NumberCycles Completed response field 211
NumberCycles Remaining response field 211
NZD 377, 378
O
Opti ons response field 178
OrderDescription request field 62, 86, 97, 134, 258
OrderDescription response field 121
OrderID request field 65, 101, 138, 260
OrderID response field 124
OrderTotal request field 61, 86, 95, 132, 257
OrderTotal response field 119
OtherPaymentMethods request field 92
OutstandingBalance request field 224
OutstandingBalance response field 212
P
Pa yerStatus request field 59, 198
PageStyle request field 90, 233
Pal response field 156
Pare ntTransactionID response field 172, 267
Payer request field 59, 76, 198, 229, 282
Payer response field 116, 169, 213, 241, 247, 286
PayerBusiness request field 59, 198
PayerBusiness response field 117, 170, 241, 248
PayerCountry request field 59, 198
PayerCountry response field 117, 170, 241, 248
PayerDisplayName response field 286
PayerID request field 59, 130, 198, 275
PayerID response field 116, 169, 241, 247
PayerInfo response field 114, 168, 240, 247
PayerInfoType request fields 59, 76, 198, 229
PayerInfoType response fields 116, 169, 213, 241, 247
PayerName request field 59, 198, 282
PayerName request fields 60, 76, 198, 262, 284
PayerName response field 117, 170, 241, 247
PayerName response fields 170, 241, 248
PayerStatus response field 117
Paym entDetailsItem request field 135
Payment DetailsItem response field 122
PaymentAction request field 56, 91, 99, 129, 136, 253,
394
PaymentDate response field 146, 172, 267
PaymentDetai ls request field 88
PaymentDetails request field 57, 130, 254
PaymentDetails response field 115
PaymentDetailsItem request field 63, 98, 259
PaymentDetailsItemType request fields 64, 99, 136,
200, 259, 392, 393, 395
PaymentDetailsItemType response fields 122
PaymentDetailsType request fields 61, 95, 132, 257
PaymentDetailsType response fields 119
PaymentError response field 125, 150
PaymentErrorType response fields 126, 150
PaymentInfo response field 35, 143, 168, 265
PaymentInfoType response fields 145, 172, 266
PaymentItem response field 177
PaymentItemInfo response field 169
PaymentItemInfoType response fields 176
PaymentItemType response fields 177
PaymentPeriod request field 192, 225
PaymentPeriod.Amount request field 193, 194, 226
PaymentPeriod.BillingFrequency request field 193
PaymentPeriod.BillingPeriod request field 193
PaymentPeriod.TotalBillingCycles request field 193,
226
PaymentReason request field 94, 255
PaymentRequestID request field 99, 136
PaymentRequestID response field 122, 125, 149
PaymentRequestInfo response field 116
PaymentRequestInfoType response fields 125
PaymentStatus response field 42, 46, 147, 174, 269