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
SOAP API Developer Reference August 2012 395
Index
ItemCategory 383
ItemCategory request field 101, 137, 202, 382
ItemCategory response field 123
ItemHeight request field 100, 137
ItemHeight response field 123
ItemLength request field 100, 136
ItemLength response field 123
ItemNumber request field 65, 101, 137, 262
ItemNumber response field 124
ItemTotal reque stfield 61
ItemTotal request field 96, 131, 259, 384
ItemTotal response field 119
ItemURL request field 100, 137
ItemWeight request field 100, 136
ItemWeight response field 123
ItemWidth request field 100, 123, 136
J
Japanese Yen 369, 370
JPY 369, 370
K
Koruna 369, 370
Krona 369, 370
Krone 369, 370
L
LandingPage request field 92
LastName request field 60, 76, 77, 201, 231, 264, 284
LastName response field 117, 172, 215, 244, 250
LastPaymentAmount response field 214
LastPaymentDate response field 214
Locale response field 159
LocaleCode request field 90, 235
LongMessage response field 125, 152
LoyaltyCardDiscountAmount 179
LoyaltyCardDiscountCurrency 180
M
Maestro AVS response codes 372
Maestro CVV2 response codes 373
Malaysian Ringgit 369
ManagePendingTransactionStatus API operation 183
ManagePendingTransactionStatus request fields 183
ManagePendingTransactionStatus request message 183
ManagePendingTransactionStatus response fields 184
ManagePendingTransactionStatus response
message 184
ManageRecurringPaymentsProfileStatus API
operation 217
ManageRecurringPaymentsProfileStatus request
fields 217
ManageRecurringPaymentsProfileStatus request
message 217
ManageRecurringPaymentsProfileStatus response
fields 218
ManageRecurringPaymentsProfileStatus response
message 218
Mass Payment response fields 186
MassPay API operation 185
MassPay request fields 185
MassPay request message 185
MassPay response message 186
MassPayItem request field 186
MasterCard AVS response codes 371
MasterCard CVV2 response codes 373
MaxAmount request field 86
MaxFailedPayments request field 194, 227
MaxFailedPayments response field 210
Memo response field 178
MerchantSessionId request field 57, 256
MerchantStoreDetails request field 33, 277
message style 21
Mexican Peso 369
MiddleName request field 60, 76, 201, 264, 284
MiddleName response field 117, 172, 243, 250
MpiVendor3ds request field 66
MsgSubID request field 33, 36, 41, 42, 257, 268, 277,
279
MultiItem response field 180
MXN 369
MYR 369
N
Name request field 64, 65, 95, 99, 130, 135, 198, 202,
227, 258, 261, 382, 383, 384
Name response field 69, 118, 122, 153, 172, 179, 211,
216, 244, 250, 274
NetAmount request field 74
NetAmount response field 286