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
396 August 2012 SOAP API Developer Reference
NetRefundAmount response field 279
New Zealand Dollar 369, 370
NextBillingDate response field 213
NOK 369, 370
Norwegian Krone 369, 370
NoShipping request field 88
Note request field 32, 49, 217, 220, 225
Note response field 115, 142
NoteT ext request field 98
NoteText request field 134
NoteText response field 122
NoteToBuyer request field 94
Noti fyURL request field 63
NotifyURL request field 98, 134, 260
NotifyURL response field 121
NotToBuyer request field 94
Number request field 64, 100, 136, 202, 262, 382
Number response field 122, 179
NumberCycles Completed response field 213
NumberCycles Remaining response field 213
NZD 369, 370
O
OfferDetails response field 151
Opti ons response field 180
OrderDescription request field 62, 86, 97, 133, 260
OrderDescription response field 121
OrderID request field 65, 101, 137, 262
OrderID response field 124
OrderTotal request field 61, 86, 96, 131, 259
OrderTotal response field 119
OtherPaymentMethods request field 92
OutstandingBalance request field 226
OutstandingBalance response field 214
P
Pa yerStatus request field 59, 200
PageStyle request field 90, 235
Pal response field 158
Pare ntTransactionID response field 174, 269
Payer request field 59, 76, 200, 230, 282
Payer response field 116, 171, 215, 243, 249, 286
PayerBusiness request field 59, 200
PayerBusiness response field 117, 171, 243, 250
PayerCountry request field 59, 200
PayerCountry response field 117, 171, 243, 250
PayerDisplayName response field 286
PayerID request field 59, 129, 200
PayerID response field 116, 171, 243, 249
PayerInfo response field 114, 170, 242, 249
PayerInfoType request fields 59, 76, 200, 230
PayerInfoType response fields 116, 171, 215, 243, 249
PayerName request field 59, 200, 282
PayerName request fields 60, 76, 200, 264, 284
PayerName response field 117, 171, 243, 249
PayerName response fields 117, 172, 243, 250
PayerStatus response field 117
Paym entDetailsItem request field 134
Payment DetailsItem response field 121
PaymentAction request field 56, 91, 99, 128, 135, 255,
384
PaymentDate response field 145, 174, 269
PaymentDetai ls request field 88
PaymentDetails request field 57, 129, 255
PaymentDetails response field 115
PaymentDetailsItem request field 63, 98, 261
PaymentDetailsItemType request fields 64, 99, 135,
202, 261, 382, 383, 384
PaymentDetailsItemType response fields 122
PaymentDetailsType request fields 61, 96, 131, 259
PaymentDetailsType response fields 119
PaymentError response field 125, 150
PaymentErrorType response fields 125, 151
PaymentInfo respo nse field 35
PaymentInfo response field 142, 170, 267
PaymentInfoType response fields 145, 173, 268
PaymentItem response field 179
PaymentItemInfo response field 170
PaymentItemInfoType response fields 178
PaymentItemType response fields 179
PaymentPeriod request field 194, 227
PaymentPeriod.Amount request field 195, 196, 228
PaymentPeriod.BillingFrequency request field 195
PaymentPeriod.BillingPeriod request field 195
PaymentPeriod.TotalBillingCycles request field 195,
228
PaymentReason request field 94, 257
PaymentRequestID request field 99, 135
PaymentRequestID response field 122, 125, 150
PaymentRequestInfo response field 116
PaymentRequestInfoType response fields 125
PaymentStatus response field 42, 46, 147, 176, 271