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
ExpressCheckout API Operations
SetExpressCheckout API Operation
6
102 August 2012 SOAP API Developer Reference
BuyerDetailsType Fields
FundingSourceDetailsType Fields
Field Description
BuyerId xs:string
(Optional) The unique identifier provided by eBay for this buyer. The value may or
may not be the same as the username. In the case of eBay, it is different.
Character length and limitations: 255 single-byte characters
BuyerUserName xs:string
(Optional) The user name of the user at the marketplaces site.
BuyerRegistrationDa
te
xs:dateTime
(Optional) Date when the user registered with the marketplace.
Character length and limitations: Date and time are in UTC/GMTformat, for
example, 2011-06-24T05:38:48Z
TaxIdDetails ebl:TaxIdDetailsType
Details about the buyer’s tax information. This field is required for Brazil and is for
Brazil use only.
This field is introduced in API version 72.0.
Field Description
AllowPushFunding xs:string
(Optional) Indicates whether the merchant can accept push funding. It is one of the
following values:
0 – Merchant can accept push funding.
1 – Merchant cannot accept push funding.
NOTE: This field overrides the setting in the merchant's PayPal account.
AllowedPaymentMetho
d
ns:AllowedPaymentMethodType
(Optional) The type of funding sources allowed. It is one of the following values:
Default – Merchant supports all funding sources.
InstantOnly – Merchant only supports instant payments.
AnyFundingSource – All funding methods allowed, to be chosen by the buyer
irrespective of the merchant profile setting.
InstantFundingSource – Only instant funding methods are allowed. Block
echeck, meft, elevecheck. This value overrides any merchant profile settings.