Home

PayPal SOAP API Developer - 2012 Reference Manual

Contents

1. 155 GetBalance Request Message 222r 155 GetBalance Request Fields llle 155 GetBalance Response Message 2 va vr kr knr kran 156 GetBalance Response Fields llle 156 Chapter 8 GetPalDetails API Operation 157 GetPalDetails Request Message 0 lll 157 GetPalDetails Response Message 2 aa va 22e 158 GetPalDetails Response Fields 2 2 arv rv vr eee krakk 158 Chapter 9 GetTransactionDetails API Operation 161 GetTransactionDetails Request Message vr knakk nn ee ee 161 GetTransactionDetails Request Fields lll ln 161 GetTransactionDetails Response Message 2 arv rv rn knr rn naa 162 GetTransactionDetails Response Fields 2 22 arr vr rv 00002 168 PaymentTransactionDetailsType Fields llle 170 ReceiverlInfoType Fields oen 171 PayerlnfoType Fields llle 171 PayerName Fields 2222s 172 AddressType Fields o e e 172 PaymentlnfoType Fields 22e 173 SOAP API Developer Reference August 2012 5 Neal Contents PaymentltemInfoType Fields lens 178 PaymentltemType Fields lle 179 AuctionlnfoType Fields 2n 180 SubscriptionInfoType Fields arv rv vr rv rn knr nen 180 SubscriptionTermsType Fields llle 181 Chapter 10 ManagePendingTransactionStatus A
2. NOTE Not all fields shown are available for use Use only the fields described in the documentation e ProfileID ProfileStatus Description AutoBillOutstandingAmount MaxFailedPayments RecurringPaymentsProfileDetails 1 CurrentRecurringPaymentsPeriod 0 RecurringPaymentsSummary 1 CreditCard TrialRecurringPaymentsPeriod RegularRecurringPaymentsPeriod Trial mountPaid RegularAmountPaid AggregateAmount AggregateOptionalAmount FinalPaymentDueDate string RecurringPaymentsProfileStatusType string AutoBillType int RecurringPaymentsProfileDetailsType BillimgPeriodDetailsType RecurringPaymentsSummaryType CreditCardDetailsType BillimgPeriodDetailsType BillimgPeriodDetailsType BasicAmountType Basic mountType BasicAmountType BasicAmountType dateTime E RecurringPaymentsProfileStatusType E AutoBillType E RecurringPaymentsProfileDetailsType e SubscriberName 0 1 string SubscriberShippingAddress 0 1 AddressType BilingStartDate ProfileReference 1 1 dateTime 0 1 string E BillingPeriodDetailsType e e e BilingPeriod ts BilingFrequency 1 TotalBilingCycles 0 Amount 1 ShippingAmount 0 TaxAmount 0 e NextBilingDate BilingPeriodType int int Basic mountType BasicAmountType BasicAmountType 0 1 dateTime NumberCyclesC
3. te AbatractResponse Type TE ManageRecurringPaymentsProfileStatusResponseDetailsType Timestamp 0 1 dateTime el ProfileID 1 1 string e Ack AckCodeType e CorrelationID 0 1 string Errors 0 ErrorType Version string Build string F any D 1 lanageRecurringPaymentsProfileStatusResponseType oo d ManageRecurringPaymentsProfileStatusResponseDetails ManageRecurringPaymentsProfileStatusResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation ManageRecurringPaymentsProfileStatus Response Fields Field Description ProfileID xs string Recurring payments profile ID returned in the CreateRecurringPayment sProfile response For each action an error is returned if the recurring payments profile has a status that is not compatible with the action Errors are returned in the following cases e Cancel Profile status is not Active or Suspended e Suspend Profile status is not Active e Reactivate Profile status is not Suspended 218 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 BillOutstandingAmount API Operation BillOutstandingAmount API Operation The BillOutstandingAmount API operation bills the buyer for the outstanding balance associated with a recurring payments profile BillOutstandingAmount Request Message te BillOutstanding mountRequ
4. I GetTransactionDetailsResponseType amp PaymentTransactionDetails PaymentTransactionType amp ThreeDSecureDetails m ThreeDSecureInfoType NOTE Not all fields shown are available for use Use only the fields described in the documentation 162 August 2012 SOAP API Developer Reference ReceiverInfo e PayerInfo PaymentInfo PaymentItemInfo e UserSelectedOptions e GiftMessage e GiftReceipt GiftWrapName GiftwrapAmount e BuyerEmailOptIn e SurveyQuestion e SurveyChoiceSelected SOAP API Developer Reference ReceiverInfoType PayerInfoType PaymentInfoType PaymentItemInfoType UserSelectedOptionType string string string BasicAmountType string string string GetTransactionDetails API Operation GetTransactionDetails Response Message E ReceiverInfoType e Business e Receiver e ReceiverID UserIDType Email ddressType Email ddressType PayerInfoType Payer 0 1 PayerID 0 1 PayerStatus 0 1 PayerName PayerCountry 0 1 PayerBusiness 0 1 e Address 0 1 ContactPhone 0 1 e TaxIdDetails 0 1 e EnhancedPayerInfo 0 1 Email ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string AddressType string TaxIdDetailsType EnhancedPayerInfoType PaymentInfoType August 2012 Ef Transact
5. MsgSubID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation RefundTransaction Response Fields Field Description RefundTransactionID xs string Unique transaction ID of the refund Character length and limitations 17 single byte characters 278 August 2012 SOAP API Developer Reference RefundTransaction API Operation KENT RefundTransaction Response Message Field Description FeeRefundAmount ebl BasicAmountType Transaction fee refunded to original recipient of payment Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma GrossRefundAmount ebl BasicAmountType Amount refunded to the original payer Say for example a buyer makes 100 purchase the buyer was refunded 20 a week ago and is refunded 30 in this transaction The gross refund amount is 30 in this transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NetRefundAmount ebl BasicAmountType Amount subtracted from PayPal balance of the origina
6. e ConfirmationCode AddressStatusCodeType e StreetMatch MatchStatusCodeType ves ZipMatch 0 1 MatchStatusCodeType CountryCode 0 1 CountryCodeType PayPalToken 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation 28 August 2012 SOAP API Developer Reference Address Verify API Operation EN Address Verify Response Message AddressVerify Response Fields Field Description ConfirmationCode ebl AddressStatuscodeType Indicates whether the address is a confirmed address on file at PayPal It is one of the following values e None The request value of the Emai1 element does not match any email address on file at PayPal Confirmed If the response value of the StreetMatch element is Matched the entire postal address is confirmed e Unconfirmed PayPal responds that the postal address is unconfirmed NOTE The values Confirmed and Unconfirmed both indicate that the member email address passed verification StreetMatch ebl MatchStatusCodeType Indicates whether the street address matches address information on file at PayPal It is one of the following values e None The request value of the Emai1 element does not match any email address on file at PayPal No comparison of other request values was made Matched The request value of the Street element matches the first 3 single byte characters of a postal address on file for
7. 10004 10004 10478 10501 10502 10504 10505 10507 10508 10509 10510 Cart item calculation mismatch Tax calculation mismatch Invalid Data Invalid Configuration Invalid Data Invalid Data Gateway Decline Invalid Configuration Invalid Data Invalid Data Invalid Data Cart item calculation mismatch The regular non trial billing period amount is different than the sum of the amounts for each item in the cart Tax calculation mismatch The tax amount for the regular non trial billing period is different than the sum of the tax for each item in the cart Recurring payments profile description must be provided if the billing agreement type is recurring payments This transaction cannot be processed due to an invalid merchant configuration This transaction cannot be processed Please use a valid credit card This transaction cannot be processed Please enter a valid Credit Card Verification Number This transaction cannot be processed This transaction cannot be processed Please contact PayPal Customer Service This transaction cannot be processed Please enter a valid credit card expiration date This transaction cannot be processed The credit card type is not supported Try another card type Scenario When the regular non trial billing period amount is different than the sum of the amounts for each item in the cart Scenario When the tax for th
8. This field is deprecated since version 53 0 Use OrderTotal in PaymentDetailsType instead ebl BasicAmountType Optional The expected maximum total amount of the complete order including shipping cost and tax charges If the transaction includes one or more one time purchases this field is ignored For recurring payments you should pass the expected average transaction amount default 25 00 PayPal uses this value to validate the buyer s funding source Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NOTE This field is required when implementing the Instant Update API callback PayPal recommends that the maximum total amount be slightly greater than the sum of the line item order details tax and the shipping options of greatest value NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies xs string Optional Description of items the buyer is purchasing Character length and limitations 127 single byte alphanumeric characters This field is deprecated since version 53 0 Use OrderDescription in PaymentDetailsType instead August 2012 SOAP API Developer Reference ExpressCheckout API Operations SetExpressCheckout API
9. 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 O O EI AllowedPaymentMethod Type O E SellerDetails Type e Sellerld 0 1 string e SellerUserName 0 1 string e SellerRegistrationDate 0 1 dateTime e PayPalAccountlD 0 1 string e SecureMerchantAccountlD 0 1 UserlDType E PaymentActionCodeType pea E OfferDetails Type le OfferCode 0 1 string e BMLOfferlnfo 0 1 BMLOfferlnfoType El RecuringFlagType NOTE Not all fields shown are available for use Use only the fields described in the documentation string string integer BasicAmountType BasicAmountType EbayItemPaymentDetailsItemType string ProductCategoryType string MeasureType MeasureType MeasureType MeasureType string EnhancedItemDataType ItemCategoryType amp Basic mountType a currencyID CurrencyCodeType E EbayItemPaymentDetailsItemType ItemNumber 0 1 string e AuctionTransactionId 0 1 string e OrderId 0 1 string e CartID 0 1 string E ProductCategoryType gt MeasureType a unit token fe EnhancedItemDataType E ItemCategoryType NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation CreditCa
10. Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma InsuranceTotal is available since version 53 0 ebl BasicAmountType Optional Shipping discount for this order specified as a negative number NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a negative number It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingDiscount is available since version 53 0 xs boolean Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No ebl BasicAmountType Optional Total handling costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive n
11. NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingTotal ebl BasicAmountType Optional Total shipping costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 119 120 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description InsuranceTotal ShippingDiscount InsuranceOptionOffered HandlingTotal ebl BasicAmountType Optional Total shipping insurance costs for this order The value must be a non negative currency amount or nul1 if you offer insurance options NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitatio
12. SOAP API Developer Reference August 2012 67 68 DoDirectPayment API Operation DoDirectPayment Response Message DoDirectPayment Response Fields Field Description TransactionID xs string Unique transaction ID of the payment NOTE If the PaymentAction of the request was Authorization the value of TransactionID is your AuthorizationID for use with the Authorization and Capture APIs Character length and limitations 19 single byte characters Amount ebl BasicAmountType This value is the amount of the payment as specified by you on DoDirectPaymentRequest for reference transactions with direct payments AVSCode xs string Address Verification System response code Character length and limitations 1 single byte alphanumeric character CVV2Code xs string Result of the CVV2 check by PayPal FMFDetails ebl FMFDetailsType Fraud filter details PaymentAdviceCode xs string Response code from the processor when a recurrng transaction is declined For details on the codes see https merchant paypal com us cgi bin 8cmd _render content amp content ID merchant cc compliance error codes Related information AVS Response Codes AVS Response Codes for Visa MasterCard Discover and American Express AVS Response Codes for Maestro FMFDetailsType Fields Field Description AcceptFilters xs RiskFilterListType List of filters that recommend acceptance of the payment DenyFilters xs RiskFilterListType List of filters that
13. Scenario When merchant passes an item category value other than Digital or Physical This transaction cannot be processed without a Credit Card Verification number SOAP API Developer Reference August 2012 355 356 API Error Codes Address Verify API Errors AddressVerify API Errors AddressVerify API Errors Error Code Short Message Long Message 10004 10004 10004 10009 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details The API is disabled Invalid email format Invalid street format Invalid zip format The Address API is currently disabled ManagePendingTransactionStatus API Errors ManagePendingTransactionStatus API Errors Error Code Short Message Long Message 11614 11614 Could not process your request to accept deny the transaction The transaction has already been Accepted Denied and the status cannot be changed Could not process your request to accept deny the transaction The transaction has already been Accepted Denied and the status cannot be changed August 2012 SOAP API Developer Reference Countries and Regions Supported by PayPal PayPal uses 2 character IS0 3166 1 codes for specifying
14. 152 August 2012 SOAP API Developer Reference ExpressCheckout API Operations DoExpressCheckoutPayment API Operation RiskFilterListType Fields Field Description ID Name Description XS int Filter ID It is one of the following values XS 1 AVS No Match 2 AVS Partial Match 3 AVS Unavailable Unsupported 4 Card Security Code CSC Mismatch 5 Maximum Transaction Amount 6 Unconfirmed Address 7 Country Monitor 8 Large Order Number 9 Billing Shipping Address Mismatch 10 Risky ZIP Code 11 Suspected Freight Forwarder Check 12 Total Purchase Price Minimum 13 IP Address Velocity 14 Risky Email Address Domain Check 15 Risky Bank Identification Number BIN Check 16 Risky IP Address Range 17 PayPal Fraud Model string Filter name XS string Filter description SOAP API Developer Reference August 2012 153 ENS ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 154 August 2012 SOAP API Developer Reference GetBalance API Operation The GetBalance API Operation obtains the available balance for a PayPal account GetBalance Request Message Detaillevel 0 DetaillevelCodeType e ErrorLanguage 0 1 string Version string F any 0 1 GetBalanceRequestType ses ReturnAllCurrencies 0 1 string NOTE Not all fields shown are available for use Use only the fields describe
15. Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs integer Optional Item weight corresponds to the weight of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer xs integer Optional Item length corresponds to the length of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer xs integer Optional Item width corresponds to the width of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer xs integer Optional Item height corresponds to the height of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer eBl ebayItemPaymentDetailsItemType Optional Information relating to an auction sale on eBay xs string Optional URL for the item August 2012 SOAP API Developer Reference ExpressCheckout API Operations SetExpressCheckout API Operat
16. DoVoid Response Message o AbstractResponseType Timestamp 0 1 dateTime el Ack AckCodeType CorrelationID 0 1 string gt Errors 0 ErrorType Version string gt Build string any DoVoidResponseType e AuthorizationID string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 49 NS Authorization and Capture API Operation Reference DoVoid API Operation DoVoidResponse Fields Field Description AuthorizationID xs string Authorization identification number you specified in the request Character length and limitations 19 single byte characters 50 August 2012 SOAP API Developer Reference DoDirectPayment API Operation The DoDirect Payment API Operation enables you to process a credit card payment DoDirectPayment Request Message le AbstractRequestType 4 DoDirectPaymentRequestDetailsType DetailLevel 0 DetaillevelCodeType PaymentAction PaymentActionCodeType ErrorLanguage 0 1 string PaymentDetails PaymentDetailsType Version string CreditCard CreditCardDetailsType PE any 0 1 IPAddress string MerchantSessionId 0 1 string ReturnFMFDetails 0 1 boolean DoDirectPaymentRequestType El DoDirectPaymentRequestDetails DoDirectPaymentRequestDetailsType e ReturnFMFDetails 0 1 int NOTE Not all fields shown are available for us
17. Le transaction Le thay ransernnl E karerr ransartiantl El kerani E Iransarhinni ype F0 ment iyne Fefiincso ir nde Lyne expartadac Ferki learnate kayman ace Grocsarrni int Heeamaunt erHeArari mt Tax mannt Fxrharge3ate FaynantFat 15 FendingRez an E Reason cda E HcldCecision E Shippngvietkod E Frote tiorEigibilt ShipArrount E ShipHandlzAmourt E ShigDiscourt E hsuranceAnoant E Subject E Sellerdatails le FaynentPequestiC le FMFDe ailz Le Erhanced aymerkln o le FaynentErro le InstrumertDetais le Offerdatails E Frote tiorEigibiltsType i47 tr Ll its string string Iransartinr id string Payment Iransarhen ade tyne Payment ndal yre To Bef inden ire nde lyne dere lime dare lime Hesramoinrl ype KaSrAmnt ype R sr maintTypr ul Rasr manntType string Payme tah isCaceTvne Pendngstang hdeTyns ul Reve salPeazorCode ype string string string string string string string string string nl SellerDe zilsTyp I string 7 FMFDetailt ype Erhanced aynertirfoTyp gt ErorType 7 InstrunertDetalsType Z OfferDe ailsTyps li JeerSelectadOptionTvpe e Chippngcalzulaticrode 3 17 string E InsuranceOp ionCelected 3 17 string SHepngdptionIsDefault e Ship ngdption mcunt e Shigpnadptionhare 2 1 strin
18. StartYear IssueNumber xs int Optional Year that Maestro card was issued Character length and limitations 4 digits xs string Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum PayerNameType Fields Field Salutation FirstName MiddleName LastName Suffix Description xs string Optional Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Optional Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Optional Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Optional Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Optional Buyer s suffix Character length and limitations 12 single byte characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation DoReferenceTransaction Response Message i AbstractResponseType i DoReferenceTransactionResponseDetailsType Timestamp 0 1 dateTime BillingAgreementID 0 1 string e Ack AckCodeType PaymentInfo 0 1 PaymentinfoType CorrelationID 0 1 string Amount 0 1 BasicAmountType Errors 0 ErrorType AVSCode 0 1 string Version string CVV2Code 0 1 string Build string TransactionID 0 1
19. 0 Shipping mount 1 1 BillingPeriodType int int 1 1 BasicAmountType 0 1 BasicAmountType 0 1 BasicAmountType Is ActivationDetailsType 1 1 BasicAmountType FailedInitial mountAction 0 1 FailedPaymentActionType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 191 192 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation BillingPeriod 1 1 e BilingFrequency 1 1 e TotalBillingCycles 0 1 e Amount 1 1 e Shipping mount 0 1 TaxAmount 0 1 BillingPeriodDetailsType BillingPeriodType int int BasicAmountType BasicAmountType BasicAmountType E BillingPeriodT ype BasicAmountType CurrencyCodeType a currencyID NOTE Not all fields shown are available for use Use only the fields described in the documentation E PaymentDetailsItemType E Name e Number Quantity e Tax Amount EbayItemPaymentDetailsItem PromoCode ProductCategory Description Itemweight ItemLength Itemwidth ItemHeight ItemURL EnhancedItemData ItemCategory string string integer BasicAmountType BasicAmountType EbayItemPaymentDetailsItemType string ProductCategoryType string
20. 10007 Permission denied You do not have permission to make this API call 10007 Permission denied You do not have permission to get the details of this transaction SOAP API Developer Reference August 2012 317 318 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10007 Permission denied You do not have permission to make this API call 10408 Express Checkout token is Express Checkout token is missing missing 10409 You re not authorized to Express Checkout token was issued for access this info a merchant account other than yours 10410 Invalid token Invalid token 10411 This Express Checkout This Express Checkout session has session has expired expired Token value is no longer valid 13112 Cannot Pay Seller The Buyer will not be able to Pay the seller for this transaction 13116 Transaction refused because The transaction is in progress for this of an invalid argument See additional error messages for details token DoExpressCheckoutPayment API Errors DoExpressCheckoutPayment API Errors Error Code 10001 10001 10001 10001 10004 10004 Short Message Internal Error Internal Error ButtonSource value truncated Internal Error Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages fo
21. 10712 Invalid Data 10713 Invalid Data 10713 Invalid Data 10714 Invalid Data 10715 Invalid Data 10716 Invalid Data There s an error with this transaction Please enter a complete billing address There s an error with this transaction Please enter an address1 in the billing address There s an error with this transaction Please enter an address1 in the billing address There s an error with this transaction Please enter a city in the billing address There s an error with this transaction Please enter a city in the billing address There s an error with this transaction Please enter your state in the billing address There s an error with this transaction Please enter your five digit postal code in the billing address There s an error with this transaction Please enter a country in the billing address There s an error with this transaction Please enter a country in the billing address There s an error with this transaction Please enter a valid billing address There s an error with this transaction Please enter a valid state in the billing address There s an error with this transaction Please enter your five digit postal code in the billing address There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message
22. 10730 Invalid Data 10731 Invalid Data 10731 Invalid Data 10732 Invalid Data 10733 Invalid Data 10734 Invalid Data 10735 Invalid Data 10736 Invalid Data There s an error with this transaction Please enter an address in the shipping address There s an error with this transaction Please enter a city in the shipping address There s an error with this transaction Please enter a city in the shipping address There s an error with this transaction Please enter your state in the shipping address There s an error with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter a country in the shipping address There s an error with this transaction Please enter a country in the shipping address There s an error with this transaction Please enter a valid shipping address There s an error with this transaction Please enter a valid state in the shipping address There s an error with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter a valid city and state in the shipping address There was a problem with a particular field in the address The long error message tells you which field is invalid There was a proble
23. DoDirectPayment or Checkout For point of sale transactions this is the transaction ID returned by the CheckOut call when the payment action is Authorization Character length and limitations 19 single byte characters maximum ebl BasicAmountType Required Amount to capture NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl CompleteCodeType Required Indicates whether or not this is your last capture It is one of the following values e Complete This is the last capture you intend to make e NotComplete You intend to make additional captures NOTE If Complete any remaining amount of the original authorized transaction is automatically voided and all remaining open authorizations are voided xs string Optional Your invoice number or other identification number that is displayed to you and to the buyer in their transaction history The value is recorded only if the authorization you are capturing is an Express Checkout order authorization NOTE This value on DoCapture overwrites a value previously set on DoAuthorization Character length and limitations
24. MeasureType MeasureType MeasureType MeasureType string EnhancedItemDataType ItemCategoryType BasicAmountType currencyID CurrencyCodeType EbayItemPaymentDetailsItemType ItemNumber 0 1 string e AuctionTransactionId 0 1 string e OrderId 0 1 string CartID 0 1 string E ProductCategoryType MeasureType unit token EnhancedItemDataType E ItemCategoryType NOTE Not all fields shown are available for use Use only the fields described in the documentation CreateRecurringPaymentsProfile Request Fields Field Description Token xs string A timestamped token the value of which was returned in the response to the first call to SetExpressCheckout You can also use the token returned in the SetCustomerBillingAgreement response Either this token or a credit card number is required If you include both token and credit card number the token is used and credit card number is ignored Call CreateRecurringPaymentsProfile once for each billing agreement included in SetExpressCheckout request and use the same token for each call Each CreateRecurringPaymentsProfile request creates a single recurring payments profile NOTE Tokens expire after approximately 3 hours August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description CreditCard
25. RE MassPay API Operation MassPay Response Message Field Description MassPayItem ebl MassPayItemType Required Details of each payment NOTE single MassPayRequest can include up to 250 MassPayItems ReceiverType ebl ReceiverInfoCodeType Optional How you identify the recipients of payments in this call to MassPay It is one of the following values e EmailAddress e UserID e PhoneNumber MassPay Response Message te AbstractResponseType e Timestamp 0 1 dateTime gt Ack AckCodeType e CorrelationID 0 1 string el Errors 0 ErrorType Version string 2 Build string e any MassPayResponseType NOTE Not all fields shown are available for use Use only the fields described in the documentation MassPay Response Fields The elements returned are the same as for AbstractResponseType 186 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations The PayPal API includes the following API operations supporting recurring payments and reference transactions CreateRecurringPaymentsProfile API Operation The CreateRecurringPaymentsProfile API operation creates a recurring payments profile You must invoke the CreateRecurringPaymentsProfile API operation for each profile you want to create The API operation creates a profile and an associated billing agreement NOTE There is a one to one correspondence between billing agree
26. RecurringPayments ProfileDetails ScheduleDetails ns CreditCardDetailsType Credit card information for recurring payments using direct payments Either a token or a credit card number is required If you include both token and credit card number the token is used and credit card number is ignored ns RecurringPaymentsProfileDetails Required You can include up to 10 recurring payments profiles per request The order of the profile details must match the order of the billing agreement details specified in the SetExpressCheckout request ns ScheduleDetailsType Required Describes the recurring payments schedule including the regular payment period whether there is a trial period and the number of payments that can fail before a profile is suspended RecurringPaymentsProfileDetailsType Fields Field Description SubscriberName SubscriberShipping Address BillingStartdate ProfileReference xs string Optional Full name of the person receiving the product or service paid for by the recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters ns AddressType Optional The subscriber s shipping address associated with this profile if applicable If not specified the ship to address from buyer s PayPal account is used NOTE Shipping Address is optional but if you include it certain fields are required xs d
27. SetExpressCheckout API Operation The SetExpressCheckout API operation initiates an Express Checkout transaction SetExpressCheckout Request Message SOAP API Developer Reference August 2012 79 ExpressCheckout API Operations SetExpressCheckout API Operation SetExpressCheckoutRequestDetailsType 1s AbatraciReguestIype DetailLevel 0 DetaillevelCodeType OrderTotal BasicAmountType ErrorLanguage 0 1 string ReturnURL string Version string CancelURL string FE any 0 1 TrackingImageURL 0 1 string giropaySuccessURL 0 1 string giropayCancelURL 0 1 string el BanktxnPendingURL 0 1 string E SetExpressCheckoutRequestType el Token D 1 ExpressCheckoutTokenType el OrderDescription 0 1 string Custom 0 1 string InvoicelD 0 1 string ReqConfirmShipping 0 1 string el RegBillingAddress 0 1 string BillingAddress 0 1 AddressType el NoShipping 0 1 string el AddressOverride 0 1 string el LocaleCode 0 1 string el PageStyle 0 1 string el cpp header image 0 1 string el cpp header border color 0 1 string el cpp header back color 0 1 string el cpp payflow color 0 1 string el cpp cart border color 0 1 string el cpp logo image 0 1 string el Address 0 1 AddressType el PaymentAction 0 1 PaymentActionCodeType el SolutionType 0 1 SolutionTypeType el LandingPage 0 1 LandingPageType BuyerEmail 0 1 Email ddressType el ChannelTy
28. Specifically the merchant has set the filter to decline transactions when the AVS is unsupported SOAP API Developer Reference August 2012 295 296 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10564 Gateway Decline This transaction cannot be There was a problem processing this processed transaction 10565 Merchant country The merchant country is not unsupported supported 10566 Credit card type The credit card type is not unsupported supported 10567 Invalid Data This transaction cannot be processed Please enter a valid credit card number and type 10571 Transaction approved but This transaction was approved If you want to require valid CVV values with invalid Card although the Card Security Code change the risk control settings in your Security Code CSC CSC had too few too many or account profile format invalid characters Based on your account profile settings the invalid CSC was not given to the card issuer for its approval process 10701 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error billing address message tells you which field is invalid 10702 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address in the billing address message tells
29. e Good result 2 or D e Badresult I Attempted authentication e Good result 3 6 8 A or C e Bad result 4 7 or 9 No liability shift Blank 0 or B EciSubmitted3ds Electronic Commerce Indicator ECI that PayPal submitted with the payment authorisation request This might not be the same value received from the merchant In rare cases PayPal is required to use a different ECI for authorisation based on the full set of 3 D Secure values provided from the cmpi authenticate request MasterCard e 01 Merchant Liability e 02 Issuer Liability Visa e 05 Issuer Liability e 06 Issuer Liability e 07 Merchant Liability 70 August 2012 SOAP API Developer Reference DoNonReferencedCredit API Operation The DoNonReferencedCredit API issues a credit to a card not referenced by the original transaction DoNonReferencedCredit Request Message i DoNonReferencedCreditRequestDetailsType te AbstractRequestType e DetailLevel 0 DetailLevelCodeType Amount BasicAmountType el Errorlanguage 0 1 string NetAmount 0 BasicAmountType Version string FE any 0 1 TaxAmount 0 BasicAmountType Shipping mount 0 1 BasicAmountType CreditCard CreditCardDetailsType ReceiverEmail 0 1 string Comment 0 1 string E DoNonReferencedCreditRequestType sea d DoNonReferencedCreditRequestDetails DoNonReferencedCreditRequestDetailsType NOTE Not all fields shown are
30. string AddressType ShippingServiceCodeType dateTime PaymentDetailsItemType BasicAmountType BasicAmountType string AllowedPaymentMethodType SellerDetailsType string string PaymentActionCodeType string string string integer OfferDetailsType Airlineltinerary 0 1 AirlineltineraryType E UserSelectedOptionType e ShippingCalculationMode 0 1 InsuranceOptionSelected 0 1 e ShippingOptionIsDefault 0 1 0 1 0 1 e ShippingOption amp mount e ShippingOptionName BasicAmountType 2 currencyID CurrencyCodeType string string string BasicAmountType string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 127 Operations o ExpressCheckout API DoExpressCheckoutPayment API Operation PaymentDetailsItemType BasicAmountType Name Number Quantity S s a s Tax Amount e e EbayItemPaymentDetailsItem PromoCode ProductCategory Description ItemWeight ItemLength TtemWidth TtemHeight TtemURL e le el ei el el e o e EnhancedItemData e ItemCategory 0 1 string currencyID CurrencyCodeType 0 1 string EbayItemPaymentDetailsItemType 0 1 integer 0 1 BasicAmountType ItemNumber 0 1 string e AuctionTransactionId 0 1 string e OrderId
31. 0 1 MeasureType e ItemLength 0 1 MeasureType e Itemwidth 0 1 MeasureType e ItemHeight 0 1 MeasureType e ItemURL 0 1 string e EnhancedItemData 0 1 EnhancedItemDataType e ItemCategory 0 1 ItemCategoryType Use only the fields described in the SOAP API Developer Reference e CreditCardType 0 e CreditCardNumber 0 ExpMonth 0 Exprear 0 CardOwner 0 gewe 0 StartMonth 0 e StartYear 0 IssueNumber 0 e ThreeDSecureRequest 0 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation E CreditCardDetailsType CreditCardTypeType string int int PayerInfoType string int int string ThreeDSecureRequestType E CreditCardTypeType E PayerInfoType e Payer 0 PayerID 0 e PayerStatus 0 e PayerName e PayerCountry 0 e PayerBusiness 0 Address 0 e ContactPhone 0 i ThreeDSecureRequestType e Eci3ds 0 e Cavv 0 e xid 0 e Mpivendor3ds O e AuthStatus3ds 0 Email ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string AddressType string 41 string 1 string 1 string 1 string 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Referen
32. 1 string e Version string FE any 0 1 SOAP API Developer Reference ItemPrice ItemCount ItemCountUnit e Discount Taxable TaxRate AdditionalFees Reimbursable MPN ISBN PLU ModelNumber e StyleNumber August 2012 TransactionID Transactionid InvoicelD 0 1 string p E Storelb 1 1 string e RefundType 0 1 RefundType e TerminallD 0 1 string e Amount 0 1 BasicAmountType Memo 0 1 string e RetryUntil 0 1 dateTime Name string e RefundSource 0 1 RefundSourceCodeType Description string RefundAdvice 0 1 boolean e EAN string HE MerchantStoreDetails 0 1 MerchantStoreDetailsType SKU string HE RefunditemDetails 0 InvoiceltemType ReturnPolicyIdentifier string MsgSubID string E Price BasicAmountType BasicAmountType double UnitOfMeasure DiscountType boolean double AdditionalFeeType boolean string string string string string 275 DE RefundTransaction API Operation RefundTransaction Request Message NOTE Not all fields shown are available for use Use only the fields described in the documentation RefundTransaction Request Fields Field Description TransactionID InvoiceID RefundType Amount Memo RetryUntil xs string Required Unique identifier of the transaction to be refunded Character length and limitations 17 single byte alphanumeric characters xs
33. 1 string e ProtectioneEligibilty 0 1 string e ShipAmount 0 1 string e ShipHandle mount 0 1 string e ShipDiscount 0 1 string InsuranceAmount 0 1 string Subject string NOTE Not all fields shown are available for use Use only the fields described in the documentation E RiskFilterListType E FMFDetailsType ses Je Filters 1 RiskFilterDetailsType e AcceptFilters 0 1 RiskFilterListType e PendingFilters 0 1 RiskFilterListType e DenyFilters 0 1 RiskFilterListType e ReportFilters 0 1 RiskFilterListType NOTE Not all fields shown are available for use Use only the fields described in the documentation DoReferenceTransaction Response Fields for Express Checkout Field Description Payment Info ns Payment InfoType Information about the payment such as the transaction ID whether the payment is instant or delayed and the settlement amount SOAP API Developer Reference August 2012 267 FE Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description AVSCode CVV2Code BillingAgreementID FMFDetails PaymentAdviceCode MsgSubId xs string Address Verification System response code Character limit 1 single byte alphanumeric character xs string Result of the CVV2 check by PayPal xs string Billing agreement identifier returned if the val
34. 100 single byte characters xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters SOAP API Developer Reference August 2012 227 Fe Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description StateOrProvince PostalCode Country Phone xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters ebl CountryCodeType Country code It is required if using a shipping address Character length and limitations 2 single byte characters xs string Optional Phone number Character length and limitations 20 single byte characters BillingPeriodDetailsType Fields Field Description PaymentPeriod Total BillingCycles PaymentPeriod Amoun t TrialPeriod TotalBi llingCycles xs int Optional Number of billing cycles for payment period e For the regular payment period if no value is specified or the value is O the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater than 0 the regular payment pe
35. 311 312 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10729 Shipping Address State The field Shipping Address State is Empty required 10730 Shipping Address Postal The field Shipping Address Postal Code Empty Code is required 10731 Shipping Address Country The field Shipping Address Country Empty is required 10736 Shipping Address Invalid A match of the Shipping Address City State Postal Code City State and Postal Code failed 10800 Invalid Data Your request is too long Check URLs and other long strings 11001 Exceeds maximum length Value of NoteText element is truncated 11001 Exceeds maximum length OtherPaymentMethodID exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLabel exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLabelDescripti on exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLongDescripti on exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLongDescripti onTitle exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodIcon exceeds maximum length 11068 Seller restriction All sellers restricted 11547 Recurring payments Recurring payments temporarily temporarily unavailable try unavailable again later 11547 Permission denied Permission Denied You are not authorized to do this kind of transaction 11601 Request for billing address Billin
36. 354 API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10725 Shipping Address Country There was an error in the Shipping Shipping address error in Error Address Country field country field 10727 Shipping Address1 Empty The field Shipping Address 1 is Shipping address error in required address1 field 10728 Shipping Address City The field Shipping Address City is Shipping address error in city Empty required field 10729 Shipping Address State The field Shipping Address Stateis Shipping address error in state Empty required field 10730 Shipping Address Postal The field Shipping Address Postal Shipping address error in postal Code Empty Code is required code 10731 Shipping Address Country The field Shipping Address Country code is empty in Empty Country is required shipping address 10736 Shipping Address Invalid A match of the Shipping Address Match of shipping address city City State Postal Code City State and Postal Code failed state and postal code failed 10747 Invalid Data This transaction cannot be IPAddress field is invalid processed without a valid IP address 10748 Invalid Data This transaction cannot be CVV2 field is missing processed without a Credit Card Verification number 10755 Unsupported Currency This transaction cannot be processed due to an unsupported currency 11084 User does not have a good User does not have a good funding Scenario Th
37. Address Verify response fields 29 Address Verify response message 28 Aggregate Amount response field 210 AggregateOptionalAmount response field 210 AllowedPaymentMethod request field 102 AllowedPaymentMethodType request field 98 122 134 AllowNote request field 88 AllowPushFunding request field 102 American Express AVS response codes 371 American Express CVV2 response codes 373 Amount request field 32 40 45 64 73 99 136 202 220 226 261 276 382 383 385 Amount response field 41 68 78 122 180 181 213 Auction response field 179 AuctionInfoType response fields 180 AuctionItemNumber request field 283 AuctionTransaction Id request field 65 101 137 262 AuctionTransaction Id response field 124 AUD 369 370 Australian Dollar 369 370 Authorization and Capture API Operation Reference 31 SOAP API Developer Reference AuthorizationID request field 32 45 49 AuthorizationID response field 35 45 50 AuthorizationType response fields 42 46 AuthStatus3ds request field 66 AutoBillOutstandingAmount request field 194 226 AutoBillOutstandingAmount response field 210 AVS and CVV2 response codes 371 AVS response codes 371 AVSCode response field 68 268 Balance response field 156 BalanceHoldings response field 156 BalanceTimeStamp response field 156 BanktxnPendingURL request field 92 BAUpdate API operation 245 BAUpdate request fields 245 BAUpdate request message 245 BAUpdate response fields 248 BAUpdate re
38. August 2012 SOAP API Developer Reference DoNonReferencedCredit API Operation Ca DoNonReferencedCredit Request Message Field Description LastName ns PersonNameType Required Buyer s last name Character length and limitations 25 single byte characters Address ns AddressType Required Buyer s billing address information AddressType Fields Field Description Street1 xs string Required First street address Character length and limitations 100 single byte characters Street2 xs string Optional Second street address Character length and limitations 100 single byte characters CityName xs string Required Name of city Character length and limitations 40 single byte characters StateOrProvince xs string Required State or province Character length and limitations 40 single byte characters Country ebl CountryCodeType Required Country code Character length and limitationst 2 single byte characters PostalCode xs string Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters SOAP API Developer Reference August 2012 77 DoNonReferencedCredit API Operation DoNonReferencedCredit Response Message DoNonReferencedCredit Response Message t AbstractResponseType DoNonReferencedCreditResponseDetailsType e Ti
39. Character length and limitations Any positive integer Tax ebl BasicAmountType Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ItemWeight xs integer Weight of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer ItemLength xs integer Length of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer ItemWidth xS integer Width of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer ItemHeight xs integer Height of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer EbayItemPayment eBl ebayItemPaymentDetailsItemType DetailsItem Information relating to an auction sale on eBay ItemCategory ns ItemCat
40. CorrelationID 0 1 Errors Version Build any 0 eee e GetRecurringPaymentsProfileDetailsResponseDetails 0 1 dateTime AckCodeType string ErrorType string string GetRecurringPaymentsProfileDetailsResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation fe GetRecurringPaymentsProfileDetailsResponseDetailsT ype SOAP API Developer Reference ProfileID ProfileStatus Description AutoBillOutstandingAmount MaxFailedPayments RecurringPaymentsProfileDetails CurrentRecurringPaymentsPeriod RecurringPaymentsSummary CreditCard TrialRecurringPaymentsPeriod RegularRecurringPaymentsPeriod TrialAmountPaid RegularAmountPaid AggregateAmount AggregateOptional mount FinalPaymentDueDate i 1 ie is 1 1 0 Ed 0 0 0 0 0 0 0 0 1 4 1 1 4 4 1 1 1 4 4 1 1 1 4 1 string RecurringPaymentsProfileStatusType string AutoBillType imt RecurringPaymentsProfileDetailsType BillingPeriodDetailsType RecurringPaymentsSummaryType CreditCardDetailsType BillingPeriodDetailsType BillingPeriodDetailsType BasicAmountType BasicAmountType BasicAmountT ype BasicAmountT ype dateTime August 2012 205 12 206 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation
41. Description Salutation FirstName MiddleName LastName Suffix xs string Optional Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Required Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Optional Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Required Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Optional Buyer s suffix Character length and limitations 12 single byte characters AddressType Fields Field Description Streetl Street2 CityName StateOrProvince Country xs string Required First street address Character length and limitations 100 single byte characters xs string Optional Second street address Character length and limitations 100 single byte characters xs string Required Name of city Character length and limitations 40 single byte characters xs string Required State or province Character length and limitations 40 single byte characters ebl CountryCodeType Required Country code Character length and limitationst 2 single byte characters August 2012 SOAP API Developer Reference DoDirectPayment API Operation am DoDirectPayment Request Message Field Description PostalCode xs string Required U S ZIP code or other country
42. If the survey question is present at least 2 survey answer options need to be present Limitations 50 single byte characters xs string Survey response the buyer selected on the PayPal pages Limitations 15 single byte characters PaymentTransactionDetailsType Fields Field Description ReceiverInfo ebl ReceiverInfoType Information about the merchant such as details of a single transaction primary email address and unique account ID PayerInfo ebl PayerInfoType Information about the buyer such as the buyer s email address customer account identification number shipping address and country of residence Payment Info ebl Payment InfoType Information about the transaction such as the transaction ID the type of transaction and whether the payment is instant or delayed PaymentItemInfo ebl Payment ItemInfoType Information about the payment item such as the sales tax the invoice number and whether the buyer left a note to the merchant 170 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation CENT GetTransactionDetails Response Message ReceiverlnfoType Fields Field Description Business xs string Details about a single transaction This field is not application for point of sale transactions Receiver xs string Primary email address of the payment recipient the merchant If you are the recipient of the payment and the payment is sent to your non primary emai
43. SoftDescriptor BasicAmountType BasicAmountType BasicAmountType BasicAmountType BasicAmountType string string string string string AddressType ShippingServiceCodeType dateTime PaymentDetailsltemType BasicAmountType BasicAmountType string AllowedPaymentMethodType EnhancedPaymentDataType SellerDetailsType string string PaymentActionCodeType string string string ExpressCheckout API Operations GetExpressCheckoutDetails API Operation BasicAmountType CurrencyCod 3 currencyID leType s AddressType Name 0 1 string e Street1 0 1 string Street2 D 1 string CityName 0 1 string StateOrProvince 0 1 string EE Country 0 1 CountryCodeType dEl CountryName 0 1 string e Phone 0 1 string e PostalCode 0 1 string AddressID D 1 string AddressOwner 0 1 AddressOwnerCodeType e ExternalAddressID D 1 string e InternationalName 0 1 string InternationalStateAndCity 0 1 string InternationalStreet D 1 string e AddressStatus 0 1 AddressStatusCodeType e PayPalAccountID 0 1 string E ShippingServiceCodeType 1 E PaymentDetailsItemType Name 0 1 string
44. The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from the buyer s bank account e In Progress The transaction has not terminated For example an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e Reversed A payment was reversed due to a chargeback or other type of reversal PayPal removes the funds from your account balance and returns them to the buyer The ReasonCode element specifies the reason for the reversal e Processed payment has been accepted e Voided An authorization for this transaction has been voided 42 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description PendingReason ebl PendingStatusCodeType Reason the payment is pending It is one of the following values e none No pending reason e address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile e authorization The payment is pending because it has been authoriz
45. Transactionld FE any 0 1 PaymentAdviceCode 0 1 string MsgSubID 0 1 string o E DoReferenceTransactionResponseType DoReferenceTransactionResponseDetails 1 1 DoReferenceTransactionResponseDetailsType e PendingFilters 0 1 RiskFilterListType FMFDetails 0 1 FMFDetailsType Te Denyfilters 0 1 RiskFilterListType e ReportFilters 0 1 RiskFilterListType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 265 12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 1 DoReferenceTransactionResponseDetailsType E PaymentInfoType e Biling amp greementID 0 e PaymentInfo PaymentInfoType BasicAmountType e TransactionID amp TransactionID JE EbayTransactionID e ParentTransactionID EE ReceiptID e TransactionType e PaymentType e ExpectedeCheckClearDate e PaymentDate e GrossAmount e FeeAmount e SettleAmount e TaxAmount e ExchangeRate e PaymentStatus e PendingReason e ReasonCode e ShippingMethod e ProtectionEligibility e ProtectionEligibilityType e ShipAmount e ShipHandleAmount e ShipDiscount e InsuranceAmount e Subject e SellerDetails e PaymentRequestID e FMFDetails e EnhancedPaymentInfo e PaymentError e Basic mountType string
46. URL for the item EnhancedItemData ed EnhancedItemDataType Optional Enhanced data for each item in the cart For eBay use only ItemCategory ns ItemCategoryType Indicates whether an item is digital or physical For digital goods this field is required and must be set to Digital It is one of the following values e Digital e Physical This field is available since version 65 1 EbayltemPaymentDetailsltemType Fields Field Description ItemNumber xs string Optional Auction item number Character length 765 single byte characters AuctionTransactionId xs string Optional Auction transaction identification number Character length 255 single byte characters OrderID xs string Optional Auction order identification number Character length 64 single byte characters Cart ID xs string Optional The unique identifier provided by eBay for this order from the buyer Character length 255 single byte characters SOAP API Developer Reference August 2012 137 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation UserSelectedOptions Fields Field Description InsuranceOptionSelec xs boolean ted Optional The option that the buyer chose for insurance It is one of the following values e Yes The buyer opted for insurance e No The buyer did not opt for insurance ShippingOptionIsDefa xs boolean ult Optional Whether the buyer chose the default shipping option It
47. amount 13100 Parallel payments Parallel payments functionality functionality is not available is not available SOAP API Developer Reference August 2012 325 326 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is Payment Request ID is missing mandatory for parallel payments 13103 Duplicate Payment Payment Request ID must be Request ID passed unique for parallel payments 13104 Transaction refused Number of payment requests because of an invalid exceeds maximum number of argument See Additional supported requests error messages for details 13106 Invalid Data You cannot pass both the new and deprecated PaymentAction parameter 13107 Parallel payments partially One or more payment requests successful failed Check individual payment responses for more information 13110 Multi Payments Sale is Due to some technical Not allowed diffculties the Multi Payments for Sale is not avaliable now please try again later 13111 Mixed Payment action not The Payment Action passed supported should be unique mixed Payment Action not supported 13113 Buyer Cannot Pay The Buyer cannot pay with PayPal for this transaction 13115 Seller ID Missing Seller ID is mandatory for parallel payments 13116 Transaction refused The transaction is
48. ee 347 CreateBillingAgreement Errors 222 ee 347 UpdateBillingAgreement Errors 22 2 av rar rv krakk rn 348 DoReferenceTransaction Errors 22e 349 AddressVerify API Errors aoaaa aa 356 ManagePendingTransactionStatus API Errors 2 arva v arr kr knr 356 Appendix B Countries and Regions Supported by PayPal 357 Appendix C State and Province Codes 365 Appendix D Currency CodeS 369 Appendix E AVS and CVV2 Response Codes 371 AVS Response Codes 1 lll sss 371 AVS Response Codes for Visa MasterCard Discover and American Express 371 AVS Response Codes for Maestro aooaa 372 CVV2 Response Codes 22222 ll s ss 373 CVV2 Response Codes for Visa MasterCard Discover and American Express 373 CVV2 Response Codes for Maestro va rv vr 00 o 373 About Previous Versions of the API 375 What s New in Version 92 0 aar a 375 What s New in Version 89 0 22 22e 375 What s New in Version 88 0 0 0 00 eee kan 375 What s New in Version 85 0 0 llle 375 What s New in Version 84 0 aoaaa 375 New Field in RefundTransaction Response svarar vr rv rakk 376 New RefundlnfoType in RefundTransaction Response 376 New Field in DoReferenceTransactionResponseDetailsType 376 New Field in DoDirectPaymentResponse 2 2 aa
49. o e e o fe e e je le o e e fe o e o lel e o lo ArderTo al ItemTotal ShippingTotal HendlingTotal TaxTota OrderDescription Custom InvoiceID Buttonsource Nrtifyl IRI ShipToAddress ShippingMethcd ProfileAddressChangeDate PaymentDetaibltem InsuranceTotal Skippingdiscount InsuranceOptionOffsred AlloweuPayniea Mel ud ErhancedPaynentData SellerDetails NeteText TransactionId PaymentAction PaymentRequestID OrderURL SoftDescriptor Offer Details 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 n 1 0 1 0 1 0 1 0 0 1 0 1 0 1 0 1 0 1 0 1 0 1 10 1 0 1 0 1 0 1 0 1 0 1 EasicAmountType EasicAmountType EasicAmountType EasicAmountType EasicAmountType string string string string tring AddressType ShippirgServiceCodeType cateTime FaymentDetailsItemType EasicAmountType EasicAmountType string A lluwedPayn e iMd ud ype EnhancedPavmentdataType SellerDetailsType string string FaymentActionCoceType string string string OfferDeLails Type August 2012 E DasicAmountType CurrencyCodeType 3 currencyID E amp ddressType Name 0 1 strinc c Streeti 0 1 strinc e Street2 0 1 strinc e CityName 0 1 strinc StateOrProvince 0 1 string El Lount y U 1 CounzryCodelyps Ef Count yNare 0 1 string e Phone 0 1 string PostalCode 0 1 stri
50. processed due to an invalid disabled or inactive merchant configuration 10502 Invalid Data This transaction cannot be The credit card used is expired processed Please use a valid credit card 10504 Invalid Data This transaction cannot be The CVV provided is invalid The CVV processed Please enter a valid is between 3 4 digits long Credit Card Verification Number 10505 Gateway Decline This transaction cannot be The transaction was refused because the processed AVS response returned the value of N and the merchant account is not able to accept such transactions August 2012 SOAP API Developer Reference API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10507 Invalid Configuration This transaction cannot be Your PayPal account is restricted processed Please contact PayPal Contact PayPal for more information Customer Service 10508 Invalid Data This transaction cannot be The expiration date must be a two digit processed Please enter a valid month and four digit year credit card expiration date 10509 Invalid Data This transaction cannot be You must submit an IP address of the processed buyer with each API call 10510 Invalid Data The credit card type is not The credit card type entered is not supported Try another card type currently supported by PayPal 10511 Invalid Data This transaction cannot be The merchant selected a value for the processed PaymentActio
51. string TransactionId string PaymentTransactionCodeType PaymentCodeType dateTime dateTime BasicAmountType BasicAmountType BasicAmountType BasicAmountType string PaymentStatusCodeType PendingStatusCodeType ReversalReasonCodeType string string string string string string string string SellerDetailsType string FMFDetailsType EnhancedPaymentInfoType ErrorType a currencyID CurrencyCodeType E TransactionId NOTE Not all fields shown are available for use Use only the fields described in the documentation 266 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation fe PaymentInfoType E TransactionId amp TransactionID string al EbayTransactionID string e ParentTransactionID 0 1 TransactionId TE ReceiptID 0 1 string El PaymentCodeType TransactionType PaymentTransactionCodeType e PaymentType 0 1 PaymentCodeType PaymentDate dateTime e Gross mount BasicAmountType e FeeAmount 0 1 BasicAmountType E PaymentstatuscodeType e SettleAmount 0 1 BasicAmountType PendingStatusCodeType e TaxAmount 0 1 Basic mountType e ExchangeRate 0 1 string m E ReversalReasonCodeType aymentStatus PaymentStatusCodeType e PendingReason 0 1 PendingStatusCodeType ReasonCode 0 1 ReversalReasonCodeType e ShippingMethod 0
52. where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Amount deposited in your PayPal account after a currency conversion Amount deposited in your PayPal account after a currency conversion You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Tax charged on the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs string Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversi
53. 0 1 string CartID 0 1 string 0 1 BasicAmountType 0 1 EbayItemPaymentDetailsItemType 0 1 string 0 1 ProductCategoryType 0 1 string 5 ProductCategoryType 0 1 MeasureType 0 1 MeasureType MeasureType 0 1 MeasureType unit token 0 1 MeasureType 0 1 string EnhancedItemDataType 0 1 EnhancedItemDataType 0 1 ItemCategoryType E ItemCategoryType TU NOTE Not all fields shown are available for use Use only the fields described in the documentation DoExpressCheckoutPayment Request Fields Field Description Token xs string Required The timestamped token value that was returned in the SetExpressCheckout response and passed in the GetExpressCheckoutDetails request Character length and limitations 20 single byte characters PaymentAction ebl PaymentAct ionCodeType deprecated Required How you want to obtain payment It is one of the following values e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture e Sale This is a final sale for which you are requesting payment NOTE You cannot set this value to Sale in the SetExpressCheckout request and then change this value to Authorization in the DoExpressCheckout Payment request Character length and limitations Up to 13 single byte alph
54. 0 and is returned only if PAYMENTINFO n PAYMENTSTATUS is Completed Funds Held ProtectionEligibili xs string ty Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values Prior to version 64 4 the kind of seller protection in force for the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy SOAP API Developer Reference August 2012 149 150 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ProtectionEligibili xs string tyType Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values Since version 64 4 the kind of seller protection in force for the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e
55. 1 BilingPeriodDetailsType Update e AddressStatus 0 1 AddressStatusCodeType e PaymentPeriod BilingPeriodDetailsType Update Lo a ft BasicAmountType a currencyID CurrencyCodeType E AutoBillType Es CreditCardDetailsType e CreditCardType ul CreditCardTypeType e CreditCardNumber 1 string e ExpMonth 1 int e ExpYear 1 int e CardOwner ul PayerInfoType e cvv2 1 string e StartMonth ul int e StartYear 1 int e IssueNumber 1 string e ThreeDSecureRequest 0 1 ThreeDSecureRequestType BilingPeriod 0 1 BillingPeriodType e BilingFrequency 0 1 int e TotalBillingCycles 0 1 int Amount 0 BasicAmountType e Shipping mount 0 1 BasicAmountType e TaxAmount 0 BasicAmountType NOTE Not all fields shown are available for use Use only the fields described in the documentation 222 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation E CreditCardTypeType E CreditCardDetailsType e CreditCardType 0 1 CreditCardTypeType CreditCardNumber 0 1 string PayerInfoType e ExpMonth 0 1 int Payer 0 1 Email ddressType ExpYear 0 1 int e PayerID 0 1 UserIDType e CardOwner 0 1 PayerInfoType e PayerStatus 0 1 PayPalUserStatusCodeType e cvv2 0 1 string PayerName Perso
56. 247 248 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation e PayerName e PayerCountry 0 e PayerBusiness 0 e Address 0 e ContactPhone 0 E PayerInfoType Payer 0 e PayerID 0 e PayerStatus 0 Email ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string AddressType string E EmailAddressType E UserIDType E PayPalUserStatusCodeType E PersonNameType e Salutation 0 e FirstName O e MiddleName 0 e LastName 0 e Suffix 0 E CountryCodeType Name Street1 Street2 e CityName StateOrProvince l Country Hl CountryName e Phone e PostalCode e AddressID e AddressOwner e External ddressID e InternationalName e InternationalStateAndCity e InternationalStreet e AddressStatus 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 SalutationType NameType NameType NameType SuffixType 1 string string string string string CountryCodeType string string string string AddressOwnerCodeType string string string string AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation BAUpdate Response Fields Field Description BillingType ns BillingCodeT
57. API Operation CENT GetTransactionDetails Response Message Field Description PendingReason ebl PendingStatusCodeType The reason the payment is pending It is one of the following values e none No pending reason e address The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile e authorization The payment is pending because it has been authorized but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview e multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment e order The payment is pending because it is part of an order that has been authorized but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The p
58. BuyerUserName request field 102 C CAD 369 370 CallbackTimeout request field 87 CallbackURL request field 87 Canadian Dollar 369 370 CancelURL request field 87 234 CardNumber request field 282 CardOwner request field 58 75 199 230 263 CardOwner response field 215 CartID request field 101 137 CartID response field 124 Cavv request field 66 ChannelType request field 92 character encoding 24 CheckoutStatus response field 115 CHF 369 370 CityName request field 60 77 201 231 CityName response field 173 211 216 244 251 ClosingDate response field 180 Comment request field 74 CompleteType request field 32 ConfirmationCode response field 29 ContactPhone response field 115 CorrelationID 24 Country request field 60 66 77 95 130 198 201 228 231 258 392 August 2012 Country response field 118 173 212 216 244 251 CountryCode response field 29 CountryCodeType 66 95 118 130 198 228 258 CountryName response field 173 216 CouponAmount response field 179 CouponAmountCurrency 179 CouponID 179 cpp header back color request field 91 236 cpp header border request field 236 cpp header border color request field 91 cpp header image request field 91 236 cpp payflow color request field 91 236 CreateBilling Agreement API operation 238 CreateBillingAgreement request fields 238 CreateBilling Agreement request message 238 CreateBilling Agreement response fields 239 CreateBilling Agreement response me
59. Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs string Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account Character length and limitations Decimal value that does not exceed 17 characters including decimal point SOAP API Developer Reference August 2012 175 pg GetTransactionDetails API Operation GetTransactionDetails Response Messag
60. Corrective Action 10744 Invalid Data This transaction cannot be There was a problem with a particular processed Please enter a valid field in the address The long error country code in the billing message tells you which field is invalid address 10745 Invalid Data This transaction cannot be There was a problem with a particular processed Please enter a valid field in the address The long error country code in the shipping message tells you which field is invalid address 10746 Invalid Data This transaction cannot be There was a problem with a particular processed Please use a valid field in the address The long error country on the billing address message tells you which field is invalid 10747 Invalid Data This transaction cannot be The merchant entered an IP address that processed was in an invalid format The IP address must be in a format such as 123 456 123 456 10748 Invalid Data This transaction cannot be The merchant s configuration requires a processed without a Credit Card CVV to be entered but no CVV was Verification Number provided with this transaction Contact PayPal if you wish to change this setting 10750 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error state in the shipping address message tells you which field is invalid 10751 Invalid Data There s an error with this The merchant provided an address either trans
61. DoDirectPayment Request Message Field Description StartYear xs int Optional Year that Maestro card was issued Character length and limitations 4 digits IssueNumber xs string Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum PayerlnfoType Fields Field Description Payer ebl EmailAddressType Required Email address of buyer Character length and limitations 127 single byte characters PayerID ebl UserIDType Optional Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PayerStatus ebl PayPalUserStatusCodeType Optional Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters PayerName ebl PersonNameType Optional First and last name of buyer PayerCountry ebl CountryCodeType Optional Buyer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations 2 single byte characters PayerBusiness xs string Optional Buyer s business name Character length and limitations 127 single byte characters Address xs string Optional Buyer s shipping address information SOAP API Developer Reference August 2012 59 60 DoDirectPayment API Operation DoDirectPayment Request Message PayerNameType Fields Field
62. Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10426 Transaction refused Item total is invalid Item Total amount is invalid because of an invalid argument See additional error messages for details 10427 Transaction refused Shipping total is invalid Shipping Total amount is invalid because of an invalid argument See additional error messages for details 10428 Transaction refused Handling total is invalid HandlingTotal amount is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total 1s invalid Tax Total amount is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Item sales tax is invalid PaymentDetailsItem Tax field is because of an invalid invalid Warning only API argument See additional executes error messages for details 10430 Transaction refused Item amount is missing PaymentDetailsItem Amount because of an invalid field is missing Warning only argument See additional API executes error messages for details 10431 Transaction refused Item amount is invalid PaymentDetailsItem Amount because of an invalid field is invalid Warning only argument See additional API executes error messages for details 10432 Transaction refused Invoice ID value exceeds InvoiceID field is too long because of an invalid maximum allowable lengt
63. Field Description ProtectionEligibili xs string ty Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy ProtectionEligibili xs string tyType Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is introduced in API version 64 4 Storeld xs string Storeld as entered in the transaction Terminal Id xs string Terminalld as entered in the transaction FMFDetailsType Fields Field Description AcceptFilters xs RiskFilterListType List of filters that recommend acceptance of the payment DenyFilters xs RiskFilterListType List of filters that recommend denial of the pa
64. If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists IMPORTANT The notify URL applies only to DoExpressCheckoutPayment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters ShipToAddress ns AddressType Optional Address to which the order is shipped PaymentDetailsItem ebl PaymentDetailsItemType Optional Details about each individual item included in the order Recurring ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment This field is introduced in version 80 0 of the API SOAP API Developer Reference August 2012 63 64 DoDirectPayment API Operation DoDirectPayment Request Message PaymentDetailsltemType Fields Field Description Name xs string Optional Item name Character length and limitations 127 single byte characters Description xs string Optional Item description Description is available since version 53 0 Character length and limitations 127 single byte characters Amount ebl BasicAmountType
65. Not having any bank account associated with your PayPal account Be sure that you have sufficient funds in your PayPal balance and that you have verified the associated bank account 10009 Transaction refused The partial refund amount must be less than or equal to the original transaction amount 10009 Transaction refused The partial refund amount must be less than or equal to the remaining amount 10009 Transaction refused The partial refund amount is not valid 10009 Transaction refused Because a complaint case exists on this transaction only a refund of the full or full remaining amount of the transaction can be issued 10009 Transaction refused You are over the time limit to perform a refund on this transaction 10009 Transaction refused Can not do a full refund after a partial refund 10009 Transaction refused Account is locked or inactive 10009 Transaction refused The partial refund must be the same currency as the original transaction 10009 Transaction refused This transaction has already been fully refunded 10009 Transaction refused Account is restricted 10009 Transaction refused You can not refund this type of transaction 10009 Transaction refused You can not do a partial refund on this transaction 334 August 2012 SOAP API Developer Reference API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10009 Transaction refused The account for the counterparty is locked or
66. Number 0 1 string Quantity 0 1 integer e Tax 0 1 BasicAmountType e Amount 0 1 BasicAmountType EbayItemPaymentDetailsItem 0 1 EbayItemPaymentDetailsItemType PromoCode 0 1 string e ProductCategory 0 1 ProductCategoryType Description 0 1 string ItemWeight 0 1 MeasureType e ItemLength 0 1 MeasureType ItemWidth 0 1 MeasureType ItemHeight D 1 MeasureType e ItemURL 0 1 string e EnhancedItemData 0 1 EnhancedltemDataType e ItemCategory 0 1 ItemCategoryType E AllowedPaymentMethodType EnhancedPaymentDataType e SellerDetailsType SellerId 0 1 string SellerUserName 0 1 string e SellerRegistrationDate 0 1 dateTime E PaymentActionCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 113 114 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Name Number Quantity e Tax e Amount PromoCode ProductCategory Description e ItemWeight ItemLength e Itemwidth ItemHeight ItemURL EnhancedItemData e ItemCategory PaymentDetailsItemType EbayItemPaymentDetailsItem BasicAmountType string currencyID CurrencyCodeType string integer E EbayItemPayme
67. Operation EMFDetallsType RiskFilterListType e AcceptFilters 0 1 RiskFilterListType ses e Filters 1 RiskFilterDetailsType e PendingFilters 0 1 RiskFilterListType e DenyFilters 0 1 RiskFilterListType e ReportFilters 0 1 RiskFilterListType NOTE Not all fields shown are available for use Use only the fields described in the documentation is Risk se e Filters 1 RiskFilterDetailsType erListType RiskFilterDetailsType e Id 1 1 int e Name 1 1 string e Description 1 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation DoExpressCheckoutPayment Response Fields Field Description Token PaymentInfo Note RedirectRequired xs string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters ebl Payment InfoType Information about the payment xs string The text entered by the buyer on the PayPal website if you set the AllowNote field to 1 in SetExpressCheckout This field is available since version 53 0 Character length and limitations 255 single byte characters xs boolean Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction Tf set to true you can redirect users to the following URL with
68. Optional Sum of tax for all items in this order NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Character length and limitations The value must be zero or greater and cannot exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma ShippingAmount ns BasicAmountType Optional Total shipping costs in this transaction NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Character length and limitations Value must be zero or greater and cannot exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma The only valid currencies are AUD CAD EUR GBP JPY and USD CreditCard ebl CreditCardDetailsType Required Information about the credit card to be charged ReceiverEmail xs string Comment xs string Optional Field used by merchant to record why this credit was issued to a buyer It 1s similar to a memo field freeform text or string field 74 August 2012 SOAP API Developer Reference DoNonReferencedCredit API Operation Ca DoNonReferencedCredit Request Message CreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Optional Type of credit card For UK only Maestro MasterCard Discover and
69. Other type of refund Value available since version 82 0 New MerchantStoreDetailsType in RefundTransaction Request Field Description StoreID xs string ID of the merchant store This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 84 0 378 August 2012 SOAP API Developer Reference What s New in Version 80 0 NR Field Description TerminalID xs string Optional ID of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 What s New in Version 80 0 New Field in PaymentDetailsType in DoDirectPayment Request Field Description Recurring ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment This field is introduced in version 80 0 of the API New Fields in PaymentDetailsType in DoReferenceTransaction Request Field Description Recurring ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recu
70. PH PITCAIRN PN POLAND PL PORTUGAL PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW SOAP API Developer Reference August 2012 361 UE Countries and Regions Supported by PayPal 362 Country or Region Country or Region Code SAINT HELENA SAINT KITTS AND NEVIS SAINT LUCIA SAINT PIERRE AND MIQUELON SAINT VINCENT AND THE GRENADINES SAMOA SAN MARINO SAO TOME AND PRINCIPE SAUDI ARABIA SENEGAL SERBIA SEYCHELLES SINGAPORE SLOVAKIA SLOVENIA SOLOMON ISLANDS SOUTH AFRICA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS SPAIN SURINAME SVALBARD AND JAN MAYEN SWAZILAND SWEDEN SWITZERLAND TAIWAN PROVINCE OF CHINA TANZANIA UNITED REPUBLIC OF THAILAND TIMOR LESTE TOGO TOKELAU TONGA SH KN LC PM VC WS SM ST SA SN RS SC SG SK SI SB GS ES SR SJ SZ SE CH TZ TH TL TG TK TO August 2012 SOAP API Developer Reference Countries and Regions Supported by PayPal m Country or Region Country or Region Code TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS BRITISH VG VIRGIN ISLANDS U S VI WALLIS AND FUTUNA WF WESTERN SAHARA EH ZAMBIA ZM SOAP API Developer Ref
71. PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma OrderDescription xs string Optional Description of items the buyer is purchasing NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 127 single byte alphanumeric characters Custom xs string Optional A free form field for your own use NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters InvoiceID xs string Optional Your own invoice or tracking number NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters ButtonSource xs string Optional An identification code for use by third party applications to identify transactions Character length and limi
72. Reference PayPal SOAP API Basics The PayPal SOAP API is based on open standards known collectively as web services Which include the Simple Object Access Protocol SOAP Web Services Definition Language WSDL and the XML Schema Definition language XSD A wide range of development tools on a variety of platforms support web services Like many web services PayPal SOAP is a combination of client side and server side schemas hardware and software servers and core services PayPal SOAP High level Diagram PayPal API Servers Production api paypal com 2 0 api 3t paypal cor 2 0 SOAP API client f application between API serviceand Core Services PayPal main Transaction Engine Business Logic Test WY Sandbox paypal com Production www paypal com PayPal Main Interactive Site In an object oriented processing model the interface to SOAP requests responses is an object in your application s native programming language Your third party SOAP client generates business object interfaces and network stubs from PayPal provided WSDL and XSD files that specify the PayPal SOAP message structure its contents and the PayPal API service bindings A business application works with data in the form of object properties to send and receive data by calling object methods The SOAP client handles the details of building the SOAP request sending it to the PayPal service and converting the respons
73. Russia US United States The following 5 character codes are also supported for languages in specific countries da DK Danish for Denmark only he IL Hebrew all id ID Indonesian for Indonesia only jp JP Japanese for Japan only no NO Norwegian for Norway only pt BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv SE Swedish for Sweden only th TH Thai for Thailand only tr TR Turkish for Turkey only zh CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh TW Traditional Chinese for Taiwan only Character length and limitations 2 character country code xs string Optional Name of the Custom Payment Page Style for payment pages associated with this button or link It corresponds to the HTML variable page style for customizing payment pages It is the same name as the Page Style Name you chose to add or edit the page style in your PayPal Account profile Character length and limitations 30 single byte alphabetic characters August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN SetExpressCheckout API Operation Field Description cpp header image xs string Optional URL for the image you want to appear at the top left of the payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is store
74. Sale in SetExpressCheckout request and then change this value to Authorization or Order in the DoExpressCheckout Payment request If you set the field to Authorization or Order in SetExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters This field is deprecated Use PaymentAction in PaymentDetailsType instead BuyerEmail ebl EmailAddressType Optional Email address of the buyer as entered during checkout PayPal uses this value to pre fill the PayPal membership sign up portion on the PayPal pages Character length and limitations 127 single byte alphanumeric characters SOAP API Developer Reference August 2012 91 92 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description SolutionType LandingPage Channel Type giropaySuccessURL giropayCancelURL BanktxnPendingURL BillingAgreement Details Enhanced CheckoutData OtherPaymentMethods ebl SolutionTypeType Optional Type of checkout flow It is one of the following values e Sole Buyer does not need to create a PayPal account to check out This is referred to as PayPal Account Optional e Mark Buyer must have a PayPal account to check out NOTE You can pass Mark to selectively override the PayPal Account Optional setting if PayPal Account Optional is turned on in your merchant account Passing Sole has no effect if PayPal Account Optional is
75. SubscriptionInfoType e Auction 0 AuctionInfoType UserSelectedOptionType e ShippingCalculationMode 0 1 string InsuranceOptionSelected 0 1 string e ShippingOptionIsDefault 0 1 string e ShippingOption mount 0 1 BasicAmountType ShippingOptionName 0 1 string fe Basic mountType 8 currencyID CurrencyCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation 164 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation GetTransactionDetails Response Message E PayerInfoType e Payer 0 1 Email ddressType E EmailAddressType PayerID 0 1 UserIDType E UserIDType e PayerStatus 0 1 PayPalUserStatusCodeType E PayerName PersonNameType E PayPalUserStatusCodeType e PayerCountry 0 1 CountryCodeType E PersonNameType e PayerBusiness 0 1 string e Address 0 1 AddressType e ContactPhone 0 e Salutation 0 1 SalutationType e FirstName 0 1 MameType e MiddleName 0 1 MameType e LastName 0 1 NameType e Suffix 0 1 SuffixType E CountryCodeType string E AddressType e Name 1 string Street1 ha string e Street2 1 string e CityName 1 string e StateOrProvince string gl Country E CountryCodeType HF CountryName A string e Phone 1 string e PostalCode 1 string e Ad
76. The time stamped token returned in the SetCustomerBillingAgreement response NOTE The token expires after 3 hours Character length and limitations 20 single byte characters 240 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 GetBillingAgreementCustomerDetails API Operation GetBillingAgreementCustomerDetails Response Message 1 AbstractResponseType i GetBillingAgreementCustomerDetailsResponseDetailsType el Timestamp 0 1 dateTime el PayerInfo 1 1 PayerInfoType el Ack AckCodeType el Biling ddress 0 1 AddressType 9 CorrelationID 0 1 string e Errors 0 ErrorType e Version string Build string FE any 0 1 E GetBillingAgreementCustomerDetailsResponseType EE GetBillingAgreementCustomerDetailsResponseDetails GetBillingAgreementCustomerDetailsResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation E PayerInfoType E GetBillingAgreementCustomerDetailsResponseDetailsType felpaverinfo 1 1 PayerinfoType e Payer 0 1 EmailAddressType e PayerID 0 1 UserIDType e PayerStatus 0 1 PayPalUserStatusCodeType e PayerName PersonNameType e PayerInfo 1 1 PayerInfoType e BilingAddress 0 1 AddressType e PayerCountry 0 CountryCodeType e PayerBusiness 0 strin
77. Transaction refused Invalid argument description field Check the description and because of an invalid or custom field is empty and the custom fields of the billing argument See additional status is active agreement Either the description error messages for details or custom field is empty and the status is active or the contents of one of these fields exceeds the maximum field length 10201 Billing Agreement was Billing Agreement was cancelled Billing agreement has been cancelled cancelled 10204 User s account is closed or User s account is closed or restricted restricted 10209 Disabled Preapproved Payments not Merchant pull is not enabled for enabled the country or merchant is not enabled for merchant pull 10209 Disabled Preapproved Payments not Account number mismatch enabled exists for the API caller and the account the billing agreement belongs to August 2012 SOAP API Developer Reference API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10211 11451 11451 11452 Invalid billing agreement ID Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Invalid transaction or billing agreement ID could not find Billing Agreement in database Billing Agreement Id or transaction Id is not valid Billing Agreement Id or trans
78. USD SettleAmount ebl BasicAmountType Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD TaxAmount ebl BasicAmountType Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD ExchangeRate xs string Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the customer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account Character length and limitations A decimal that does not exceed 17 characters including decimal point SOAP API Developer Reference August 2012 37 NS Authorization and Capture API Operation Reference DoCapture API Operation Field Description PaymentStatus ebl PendingStatusCodeType Status of the payment It is one of the following values NOTE In a successful DoCaptur
79. UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 Storeld xs string Storeld as entered in the transaction Terminal Id xs string Terminalld as entered in the transaction EbayTransactionId xs string eBay transaction identification number eBay transaction identification number You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 255 single byte characters PaymentRequest ID xs string Unique identifier of the specific payment request The value should match the one you passed in the DoExpressCheckout request Unique identifier of the specific payment request The value should match the one you passed in the DoExpressCheckout request You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Up to 127 single byte characters EnhancedPaymentInfo xs EnhancedPayment InfoType Enhanced payment information SellerDetails xs SellerDetailsType Details about this merchant FMFDetails xs FMFDetailsType List of fraud management filters PaymentError ns ErrorType Indicates the payment status for an individual payment request in the case of parallel payments August 2012 SOAP API Developer Reference ExpressCheckout API Operations DoExpressCheckoutPayme
80. a problem with a particular field in the address The long error message will tells you which field is invalid The merchant s configuration requires a CVV to be entered but no CVV was provided with this transaction Contact PayPal if you wish to change this setting The merchant provided an address either in the United States or Canada but the state provided is not a valid state in either country The transaction was declined by the issuing bank not PayPal The merchant should attempt another card The merchant s country of residence listed in their PayPal account is not currently supported to allow Direct Payment transactions Missing token One or more subscription detail fields are missing from the request One or more schedule detail fields are missing from the request SOAP API Developer Reference August 2012 341 342 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11506 Invalid max failed Max failed payments if supplied payments must be gt 0 11507 Invalid trial amount Trial amount must be gt 0 11508 Invalid trial total billing Trial total billing cycles must be gt cycles 0 11509 Invalid trial billing period Trial billing period must be one of Day Week Month SemiMonth or Year 11510 Invalid trial amount Trial amount must be gt 0 11511 Invalid currency for trial This currency is currently not Currency must be USD amo
81. an invalid invalid argument See additional error messages for details 10412 Duplicate invoice Payment has already been made Payment already made for the for this InvoiceID invoice 10413 Transaction refused The totals of the cart item amounts Total of cart items does not because of an invalid do not match order amounts match order total argument See additional error messages for details 10414 Transaction refused The amount exceeds the maximum Amount exceeds the max because of an invalid amount for a single transaction amount for a single txn argument See additional error messages for details 10417 Transaction cannot The transaction cannot complete Account not associated with a complete successfully Instruct the customer usable funding source to use an alternative payment method 10417 Transaction cannot The transaction cannot complete Credit card or Billing Agreement complete successfully Instruct the customer is required to complete payment to use an alternative payment method 10418 Transaction refused The currencies of the shopping cart Currencies in the shopping cart because of an invalid amounts must be the same must be the same argument See additional error messages for details 10420 Transaction refused PaymentAction tag is missing PaymentAction tag is missing because of an invalid argument See additional error messages for details SOAP API Developer Reference August 2012 351 352 API
82. and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy SOAP API Developer Reference August 2012 43 NS Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description ProtectionEligibility xs string Type Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 DoReauthorization API Operation DoReauthorization Request Message te AbstractRequestType Basic mountType Detaillevel 0 DetailLevelCodeType 3 currencyID CurrencyCodeType e ErrorLanguage 0 1 string e Version string PE any 0 1 DoReauthorizationRequestType e AuthorizationID string e Amount BasicAmountType NOTE Not all fields shown are available for use Use only the fields described in the documentation 44 A
83. and limitations 15 single byte characters PaymentType ebl PaymentCodeType Indicates whether the payment is instant or delayed It is one of the following values You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters PaymentDate xs dateTime Time date stamp of payment Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z GrossAmount ebl BasicAmountType The final amount charged including any shipping and taxes from your Merchant Profile The final amount charged including any shipping and taxes from your Merchant Profile You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 145 146 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description FeeAmount SettleAmount TaxAmount ExchangeRate ebl BasicAmountType PayPal fee amount charged for the transaction PayPal fee amount charged for the transaction You can specify up to 10 payments
84. buyer s shipping address on file with PayPal be a confirmed address For digital goods this field is required and you must set it to 0 It is one of the following values e 0 You do not require the buyer s shipping address be a confirmed address e 1 You require the buyer s shipping address be a confirmed address NOTE Setting this field overrides the setting you specified in your Merchant Account Profile Character length and limitations 1 single byte numeric character xs string Determines where or not PayPal displays shipping address fields on the PayPal pages For digital goods this field is required and you must set it to 1 Itis one of the following values e 0 PayPal displays the shipping address on the PayPal pages e 1 PayPal does not display shipping address fields whatsoever e 2 f you do not pass the shipping address PayPal obtains it from the buyer s account profile Character length and limitations 4 single byte numeric characters ebl ShippingOptionsType Flat rate shipping options This field is required if you are specifying the Callback URL xs string Optional Enables the buyer to enter a note to the merchant on the PayPal page during checkout The note is returned in the GetExpressCheckoutDetails response and the DoExpressCheckoutPayment response It is one of the following values e 0 The buyer is unable to enter a note to the merchant e 1 The buyer is able to enter a note to the mer
85. byte characters L NAMEn is deprecated since version 63 0 Use L PAYMENTREQUEST 0 NAMEM instead xs string Item description For digital goods this field is required Character length and limitations 127 single byte characters 384 August 2012 SOAP API Developer Reference What s New in Version 66 EE Field Description Amount ebl BasicAmountType Cost of item For digital goods this field is required NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD Quantity xs integer Item quantity For digital goods this field is required Character length and limitations Any positive integer Changes to PaymentDetailsltemType in GetExpressCheckoutDetails Response Field Description ItemCategory ns ItemCategoryType New field Inicates whethe item is digital or physical goods For digital goods this field is required and you must set it to Digital It is one of the following values e Digital e Physical This field 1s available since version 65 1 SOAP API Developer Reference August 2012 385 a What s New in Version 66 386 August 2012 SOAP API Developer Refe
86. byte characters This field is introduced in version 53 0 Amount ebl BasicAmountType Cost of item This field is required when you pass a value for ItemCategory NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 53 0 SOAP API Developer Reference August 2012 99 100 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Number Quantity Tax ItemWeight ItemLength ItemWidth ItemHeight EbayItemPayment DetailsItem ItemURL xs string Optional Item number Character length and limitations 127 single byte characters This field is introduced in version 53 0 xs integer Item quantity This field is required when you pass a value for ItemCategory For digital goods ItemCategory Digital this field is required Character length and limitations Any positive integer This field is introduced in version 53 0 ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies
87. byte characters This field is introduced in version 69 0 ebl BasicAmountType Cost of item This field is required when ItemCategory is passed NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 69 0 xs string Optional Item number Character length and limitations 127 single byte characters This field is introduced in version 69 0 xs integer Item quantity This field is required when ItemCategory is passed Character length and limitations Any positive integer This field is introduced in version 69 0 202 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions AP Operations CreateRecurringPaymentsProfile API Operation Field Description Tax ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the
88. decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingTotal ebl BasicAmountType Optional Total shipping costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma HandlingTotal ebl BasicAmountType Optional Total handling costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 259 FE Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description TaxTotal ebl BasicAmountType Optional Sum of tax for all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported
89. decimal places the decimal separator must be a period and the optional thousands separator must be a comma ns DateTime Final scheduled payment due date before the profile expires ns CreditCardDetailsType Tf this is a recurring payments profile using direct payments this field contains the credit card information for this profile NOTE Only the last 4 digits of the credit card account number are returned The CVV2 value is not returned August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 GetRecurringPaymentsProfileDetails API Operation RecurringPaymentsProfileDetailsType Fields Field Description SubscriberName xs string Full name of the person receiving the product or service paid for by the recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters SubscriberShipping ns AddressType Address The subscriber s shipping address associated with this profile if applicable If you do not specify it the ship to address from buyer s PayPal account is used NOTE Shipping Address is optional but if you include it you are required to pass certain fields BillingStartdate xs dateTime The date when billing for this profile begins Must be a valid date in UTC GMT format NOTE The profile may take up to 24 hours for activation ProfileReference xs string The
90. decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 69 0 CreateRecurringPaymentsProfile Response Message AbstractResponseType J CreateRecurringPaymentsProfileResponseDetailsType e Timestamp 0 1 dateTime e ProfileID 1 1 string Ack AckCodeType el ProfileStatus 0 1 RecurringPaymentsProfileStatusType CorrelationID 0 1 string e TransactionID 0 1 string Errors 0 ErrorType DCCProcessorResponse 0 1 string Version string el DCCReturnCode 0 1 string e Build string FE any 0 1 E CreateRecurringPaymentsProfileResponseType CreateRecurringPaymentsProfileResponseDetailsType E CreateRecurringPaymentsProfileResponseDetails NOTE Not all fields shown are available for use Use only the fields described in the documentation CreateRecurringPaymentsProfile Response Fields Field Description ProfileID xs string A unique identifier for future reference to the details of this recurring payment Character length and limitations Up to 14 single byte alphanumeric characters ProfileStatus ns RecurringPaymentsProfileStatusType Status of the recurring payment profile e ActiveProfile The recurring payment profile has been successfully created and activated for scheduled payments according the billing instructions from the recurring payments profile e Pend
91. e InternationalStateAndCity 0 1 string e AllowedPaymentMethod 0 1 AllowedPaymentMethodType InternationalStreet 0 1 string e EnhancedPaymentData 0 AddressStatus 0 1 AddressStatusCodeType e SellerDetails NoteText e TransactionId e PaymentAction 0 0 SellerDetailsType string string PaymentActionCodeType E ShippingServiceCodeType 1 PaymentDetailsItemType e PaymentRequestID string e Name 0 1 string e OrderURL string e Number 0 1 string e SoftDescriptor string e Quantity 0 1 integer e BranchLevel integer e Tax 0 1 BasicAmountType e OfferDetails OfferDetailsType e Amount 0 1 BasicAmountType e EbayItemPaymentDetailsItem 0 1 EbayItemPaymentDetailsItemType e PromoCode 0 1 string e ProductCategory 0 1 ProductCategoryType Description 0 1 string e ItemWeight 0 1 MeasureType e ItemLength 0 1 MeasureType e ItemWidth 0 1 MeasureType e ItemHeight 0 1 MeasureType ItemURL 0 1 string e EnhancedItemData 0 1 ItemCategory 0 1 ItemCategoryType August 2012 SOAP API Developer Reference ExpressCheckout API Operations SetExpressCheckout API Operation E allowedPaymentMethodType fe EnhancedPaymentDataType l EbayPaymentDetails 0 1 EbayPaymentdetailsType Ret
92. e InternationalStreet e AddressStatus E PersonNameType e Salutation 0 1 SalutationType e FirstName 0 string string string string string CountryCodeType string string string string AddressOwnerCodeType string string string string AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the EI BilingPeriodType fe BasicAmountType documentation E BilingPeriodDetailsType_Update e BillingPeriod 0 1 BilimgPeriodType e BilingFrequency 0 1 int e TotalBillirngCycles 0 1 int e Amount 0 1 BasicAmountType 0 1 BasicAmountType 0 1 e Shipping mount e TaxAmount BasicAmountT ype a currencyID CurrencyCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile Request Fields Field Description ProfileID xs string Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API Note xs string Optional T
93. element truncated value exceeds maximum allowable length 10443 Transaction refused This transaction cannot be because of an invalid completed with argument See additional PaymentAction of Order error messages for details 10444 Transaction refused The transaction currency because of an invalid argument See additional error messages for details specified must be the same as previously specified August 2012 SOAP API Developer Reference DoExpressCheckoutPayment API Errors API Error Codes Error Code Short Message Long Message Correcting This Error 10445 10446 10474 10481 10486 10482 10537 10538 10539 10725 10727 This transaction cannot be processed at this time Please try again later Unconfirmed email Invalid Data Transaction refused because of an invalid argument See additional error messages for details This transaction couldn t be completed Transaction refused because of an invalid argument See additional error messages for details Risk Control Country Filter Failure Risk Control Max Amount Failure Payment declined by your Risk Controls settings PayPal Risk Model Shipping Address Country Error Shipping Address1 Empty This transaction cannot be processed at this time Please try again later A confirmed email is required to make this API call This transaction cannot be processed The country code in the shippin
94. from the request Invalid profile status for suspend action profile should be active Invalid profile status for reactivate action profile should be suspended The activation type is invalid The activation type is invalid The initial amount is invalid The auto bill type is invalid SOAP API Developer Reference August 2012 343 344 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11564 The number of failed The number of failed payments payments should be greater should be greater than the current than the current number of number of failed payments failed payments 11567 The time of the update is The time of the update is too close too close to the billing date to the billing date 11568 Invalid currency for Invalid currency for delinquent delinquent amount amount 11569 Cannot increase delinquent Cannot increase delinquent amount amount 11570 The maximum number of The maximum number of failed failed payments should be payments should be greater than greater than the current the current number of failed number of failed payments payments 11571 The total amount cannot The total amount cannot exceed exceed 120 increment per 12096 increment per 180 days 180 days 11576 Bill amount is greater than Bill amount is greater than outstanding balance outstanding balance 11577 Another outstanding Another outstanding payment is payment is scheduled scheduled 11578 Bill
95. immediately charged Character length and limitations 256 single byte alphanumeric characters InvoiceID xs string Optional Your own invoice or tracking number NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters Not i fyURL xs string Your URL for receiving Instant Payment Notification IPN about this transaction If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists IMPORTANT The notify URL applies only to DoExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters ShipToAddress ns AddressType Address the order is shipped to PaymentDetailsItem ebl PaymentDetailsItemType Details about each individual item included in the order SOAP API Developer Reference August 2012 121 122 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description EnhancedPaymentData ed EnhancedPaymentDataType Enhanced Data section to accept channel specific data NoteText xs string Note to the merchant Character length and limitations 255 single byte characters TransactionId xs string T
96. implementing parallel payments this field is required and must be set to Order When implementing digital goods this field is required and must be set to Sale If the transaction does not include a one time purchase this field is ignored It is one of the following values e Sale This is a final sale for which you are requesting payment default e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to Sale in SetExpressCheckout request and then change the value to Authorization or Order in the DoExpressCheckout Payment request If you set the field to Authorization or Order in SetExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters PaymentRequestID xs string A unique identifier of the specific payment request which is required for parallel payments Character length and limitations Up to 127 single byte characters PaymentDetailsltemType Fields Field Description Name xs string Item name This field is required when you pass a value for ItemCategory Character length and limitations 127 single byte characters This field is introduced in version 53 0 Description xs string Optional Item description Character length and limitations 127 single
97. in progress because of an invalid for this token argument See additional error messages for details 13751 Could not retrieve the Transaction completed original successful response successfully but could not retrieve the original successful response August 2012 SOAP API Developer Reference API Error Codes Authorization and Capture API Errors Authorization and Capture API Errors Authorization and Capture API Error Messages Error Short Returned By API Correcting This Code Message Long Message Call Error 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10004 Internal Error Invalid argument 10007 Permission You do not have denied permissions to make this API call 10009 Transaction Account is locked or Retry the request at a refused inactive later time or close order 10010 Transaction Invalid argument refused because of an invalid argument See additional error messages for details 10202 Exceed max Transaction would DoAuthorization exceed user s monthly DoCapture maximum 10600 Authorization Authorization is voided DoAuthorization Close the order or voided DoCapture authorization DoReauthorization DoVoid 10601 Authorization Authorization has DoAuthorization Close the order or expired expired DoCapture authorization DoReauthorization DoVoid 10602 Authorization Authorization has already DoAuthorization Close the order or completed b
98. includes invalid Email 10320 Internal Error Internal Error 10321 Insufficient funds The account does not have sufficient funds to do this masspay 10327 Masspay Invalid UserID The masspay input file includes invalid UserID Recurring Payments Errors The following table lists errors for the following APIs that handle recurring payments profiles e CreateRecurringPaymentsProfile e GetRecurringPaymentsProfileDetails e ManageRecurringPaymentsProfileStatus e UpdateRecurringPaymentsProfile e BillOutstandingAmount Recurring Payments Errors Error Code Short Message Long Message Additional Information 10001 Invalid account number The transaction failed as a result of invalid credit card number Check the number or attempt with another credit card 10003 Missing argument Item name amount and quantity Scenario Merchant passes item are required if item category is category as either Digital or provided Physical but does not also pass one of the following parameters name amount or quantity 10004 Transaction refused You are not signed up to accept Scenario Merchant is not signed because of an invalid payment for digitally delivered up for digital goods but passes argument See additional goods item category as Digital error messages for details August 2012 SOAP API Developer Reference API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information
99. is one of the following values e true The buyer chose the default shipping option e false The buyer did not choose the default shipping option ShippingOptionAmount ebl BasicAmountType Optional The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingOpt ionName xs string Optional The name of the shipping option such as air or ground SellerDetailsType Fields Field Description SellerID xs string Optional Unique non changing identifier for the merchant at the marketplace site This ID is not displayed Character length and limitations 13 single byte alphanumeric characters SellerUserName xs string Optional Current name of the merchant or business at the marketplace site This name may be shown to the buyer SellerRegistrationDat xs dateTime e Optional Date when the merchant registered with the marketplace Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z 138 August 2012 SOAP API Developer Reference ExpressCheckout API Operations DoExpressCheckoutPayment API Operation DoExpressCheckoutPayment Response Message 1s AbstractResponseType J i DoExpressCheckoutPaymentResponseDetail
100. merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters AddressType Shipping Fields Field Description AddressStatus ebl AddressStatusTypeCode Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed Name xs string Person s name associated with this address Character length and limitations 32 single byte characters Streetl xs string First street address Character length and limitations 100 single byte characters Street2 xs string Second street address Character length and limitations 100 single byte characters CityName xs string Name of city Character length and limitations 40 single byte characters SOAP API Developer Reference August 2012 211 FE Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description StateOrProvince xs string State or province Required for U S addresses only Character length and limitations 40 single byte characters PostalCode xs string U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters Country ebl CountryCode Country code Character length and limitations 2 single byte characters BillingPeriodDetailsType Fields Field Description BillingPeriod ns BillingPeriodType Unit for billing during this subscri
101. mount BuyerMarketingEmail e SurveyQuestion e SurveyChoiceSelected e ButtonSource e SkipBACreation E DoExpressCheckoutPaymentRequestDetailsType 0 1 0 1 0 10 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 0 1 0 1 PaymentActionCodeType ExpressCheckoutTokenType UserIDType string PaymentDetailsType string string EnhancedDataType string UserSelectedOptionType string string string BasicAmountType string string string string boolean ExpressCheckout API Operations DoExpressCheckoutPayment API Operation E PaymentActionCodeType a ExpressCheckoutTokenType E UserIDType e OrderTotal ItemTotal e ShippingTotal HandlingTotal e TaxTotal e OrderDescription e Custom InvoiceID ButtonSource NotifyURL e ShipToAddress e Shippingmethod e ProfileAddressChangeDate PaymentDetailsItem E InsuranceTotal ShippingDiscount InsuranceOptionOffered AllowedPaymentMethod EnhancedPaymentData SellerDetails NoteText e TransactionId e PaymentAction PaymentRequestID e OrderURL SoftDescriptor e BranchLevel e OfferDetails EnhancedDataType E PaymentDetailsType BasicAmountType BasicAmountType BasicAmountType BasicAmountType BasicAmountType string string string string
102. no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingDiscount is available since version 53 0 InsuranceOptionOffer xs boolean ed Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No HandlingTotal ebl BasicAmountType Optional Total handling costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TaxTotal ebl BasicAmountType Optional Sum of tax for all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decima
103. outstanding amount not Recurring payment scheduled processed because of within 24 hours so we are not scheduled payment processing the bill outstanding amount 11579 Payment is failing Payment is failing 11581 Invalid Data Profile description is invalid 11582 No payment in queue No scheduled payment has been found 11583 DPRP feature is unavailable DPRP feature is unavailable 11584 Inactive profile Profile is not active 11585 Missing Token or buyer Missing token or payment source credit card 11586 DPRP is disabled DPRP is disabled for this merchant 11587 Billing Address is Partial Billing Address is Partial August 2012 SOAP API Developer Reference API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 11590 Profile update is not Based on your input request required profile already up to date 11592 Subscription profiles are Subscription profiles are not not supported for recurring supported for recurring payments payments 13122 Transaction refused Transaction violates PayPal use 13701 Invalid Data Item Category value is invalid Scenario When merchant passes Only Digital or Physical are an item category value other than allowed Digital or Physical 15004 Gateway Decline This transaction cannot be processed Please enter a valid Credit Card Verification Number SetCustomerBillingAgreement Errors SetCustomerBillingAgreement Errors Error Code Sho
104. right to make changes to any information herein without further notice Contents What s New Whats New in Version 93 0 less Preface About This Guide rn Intended Audience ee Where to Go for More Information a Documentation Feedback 22222 llle Chapter 1 PayPal SOAP API Basics PayPal WSDL XSD Schema Definitions rv PayPal SOAP API Definitions 22s SECUN 24 xoc eae ae a a Bodd a a A A SOAP RequesterCredentials Username Password Signature and Subject SOAP Service Endpoints Lava 22e SOAP Request Envelope rn nn naa Request Structure 2 ioe a Sv ske ke Saa TA ox Ka EE a ke e SOAP Message Style doc literal 2 Response Structure kr lll sns ErrorHespons6S kw rader Sag ken E R Mek KEKE ke a a are Ga CorrelationID for Reporting Problems to PayPal 000500008 UTF 8 Character Encoding lll rs Date Time Formats i Ee Oxo TER AV AM XO RL et MO Rode LR ae Core Currency Amount Data Type 22e Chapter 2 AddressVerify API Operation AddressVerify Request Message a AddressVerifyRequest Fields ravn e e AddressVerify Response Message e AddressVerify Response Fields o 2 2 SOAP API Developer Reference August 2012 Neal Co
105. rv krakk ran 276 MerchantStoreDetails TypeFieldS o ee 277 RefundTransaction Response Message 2 av rv vrak a a 278 RefundTransaction Response Fields 22 arr vr rn naa 278 RefundlnfoType Fields lens 280 Chapter 14 TransactionSearch API Operation 281 TransactionSearch Request Message 222r 281 TransactionSearch Request Fields 2 282 PayerName Fields o 284 TransactionSearch Response Message kar ee eee eee 285 TransactionSearch Response Fields 000 vr eee 285 Appendix A API Error Codes 287 General API Errors krank rank rss 287 Validation Errors 222 2l lll sss rn 288 DirectPayment API Errors ls 291 SetExpressCheckout API Errors 2 aa vr vr vrak kr kann 303 GetExpressCheckoutDetails API Errors 2 a 317 DoExpressCheckoutPayment API Errors 2 arva vr kr ee 318 Authorization and Capture API Errors oaoa aaa 327 GetTransactionDetails API Errors 2 aa vr vr rank ark rann 331 SOAP API Developer Reference August 2012 7 Neal Contents TransactionSearch API Errors 2222s 331 RefundTransaction API Errors 2 222r 333 MassPay API Errors 2 lees 336 Recurring Payments Errors 2er 338 SetCustomerBillingAgreement Errors ln 345 GetBillingAgreementCustomerDetails Errors
106. shipping address must match the buyer s country of residence 10475 Transaction refused because This transaction cannot be completed of an invalid argument See with PaymentAction of Sale additional error messages for details 10476 Invalid Data Maximum number of billing agreements exceeded 10477 Invalid Data More than one billing agreement specified for reference transaction 10478 Invalid Data Recurring payments profile description must be provided if the billing agreement type is recurring payments 10479 Invalid Data Billing agreement types cannot be mixed in the same request 10480 Invalid Data Invalid billing agreement type 10485 Payment not authorized Payment has not been authorized by the user 10537 Risk Control Country Filter The transaction was refused because Failure the country was prohibited as a result of your Country Monitor Risk Control Settings 10538 Risk Control Max Amount The transaction was refused because Failure the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings 10539 Payment declined by your Payment declined by your Risk Risk Controls settings Controls settings PayPal Risk PayPal Risk Model Model 10725 Shipping Address Country There was an error in the Shipping Error Address Country field 10727 Shipping Address Empty The field Shipping Addressl is required 10728 Shipping Address City The field Shipping Address City is Empty required SOAP API Developer Reference August 2012
107. since version 92 0 SOAP API Developer Reference August 2012 279 DE RefundTransaction API Operation RefundTransaction Response Message RefundinfoType Fields Field Description RefundStatus ns PaymentStatusCodeType Status of the refund It is one of the following values e instant e delayed This field is available since version 84 0 PendingReason xs PendingStatusCodeType Reason that the refund payment status is delayed It is one of the following values e none The refund status is instant e echeck The refund status is delayed This field is available since version 84 0 280 August 2012 SOAP API Developer Reference TransactionSearch API Operation The TransactionSearch API searches transaction history for transactions that meet the specified criteria NOTE The maximum number of transactions that can be returned from a TransactionSearch API call is 100 TransactionSearch Request Message 1s AbstractRequestType EmailaddressType e Detaillevel 0 DetaillevelCodeType el Errorlanguage 0 1 string Transactionld e Version string F any 0 1 amp PersonNameType Salutation 0 1 SalutationType FirstName 0 1 NameType MiddleName 0 1 NameType E TransactionSearchRequestType LastName 0 1 NameType E StartDate dateTime Suffix 0 1 SuffixType e EndDate 0 1 dateTime Payer 0 1 Email ddressType PaymentTransactionClassCod
108. specific postal code Character length and limitations 20 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters PaymentDetailsType Fields Field Description OrderTotal ebl BasicAmountType Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases This field must be set to a value greater than 0 NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ItemTotal ebl BasicAmountType Optional Sum of cost of all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period a
109. string Optional Your own invoice or tracking number Character length and limitations 127 single byte alphanumeric characters ebl RefundPurposeTypeCodeType Type of refund you are making It is one of the following values e Full Full refund default e Partial Partial refund e ExternalDispute External dispute Value available since version 82 0 e Other Other type of refund Value available since version 82 0 ebl BasicAmountType Optional Refund amount The amount is required if RefundType is Partial NOTE If RefundType is Full do not set the amount Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs string Optional Custom memo about the refund Character length and limitations 255 single byte alphanumeric characters xs dateTime Optional Maximum time until you must retry the refund NOTE This field does not apply to point of sale transactions This field is available since version 82 0 276 August 2012 SOAP API Developer Reference RefundTransaction API Operation KENT RefundTransaction Request Message Field Description RefundSource ebl RefundSourceCodeType Optional Type of PayPal funding source balance or eCheck that can be used for auto refund It is one of
110. than or equal to the current outstanding balance of the profile If no value is specified PayPal attempts to bill the entire outstanding balance amount Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Note xs string Optional The reason for the non scheduled payment For profiles created using Express Checkout this message is included in the email notification to the buyer for the non scheduled payment transaction and can also be seen by both you and the buyer on the Status History page of the PayPal account BillOutstandingAmount Response Message e Timestamp 0 1 dateTime AbstractResponseType Ack CorrelationID 0 1 string Errors e Version Build f any BillOutstandingAmountResponseType l BillOutstandingAmountResponseDetails BillOutstandingAmountResponseDetailsType el ProfileID 1 1 string AckCodeType 0 ErrorType string string 0 1 BillOutstandingAmountResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation BillOutstandingAmount Response Fields Field Description ProfileID xs string Recurring payments profile ID returned in the CreateRecurringPayments
111. the PayPal member Unmatched The request value of the Street element does not match any postal address on file for the PayPal member ZipMatch ebl MatchStatusCodeType Indicates whether the zip address matches address information on file at PayPal It is one of the following values e None The request value of the Street element was unmatched No comparison of the Zip element was made e Matched The request value of the Zip element matches the zip code of the postal address on file for the PayPal member Unmatched The request value of the Zip element does not match the zip code of the postal address on file for the PayPal member CountryCode ebl CountryCodeType Country code ISO 3166 on file for the PayPal email address Character length and limitations 2 single byte characters PayPalToken xs string The token contains encrypted information about the member s email address and postal address If you pass the value of the token in the HTML variable address api tokenof Buy Now buttons PayPal prevents the buyer from using an email address or postal address other than those that PayPal verified with this API call The token is valid for 24 hours Character length and limitations 94 single byte characters SOAP API Developer Reference August 2012 29 Em AddressVerify API Operation Address Verify Response Message 30 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference The Authorizati
112. the request exceeded exceeds allowable limit DoCapture with a lower amount DoReauthorization 10611 Not enabled Authorization amp Capture DoAuthorization Contact PayPal Customer feature is not enabled for DoCapture Service the merchant Contact DoReanthorizati n customer service 10612 No more Maxmimum number of DoCapture Close the order settlement allowable settlements has been reached No more settlement for the authorization 10613 Currency Currency of capture must DoCapture Ensure that the currencies mismatch be the same as currency are the same and retry of authorization the request 10614 Cannot void You can void only the DoVoid Void the authorization reauth original authorization not a reauthorization August 2012 SOAP API Developer Reference Authorization and Capture API Errors API Error Codes Error Short Returned By API Correcting This Code Message Long Message Call Error 10615 Cannot reauth You can reauthorize only DoReauthorization Capture the reauth the original authorization reauthorization not a reauthorization 10616 Maximum Maximum number of DoReauthorization Capture or close the number of reauthorization allowed authorization reauthorization for the auth is reached allowed for the auth is reached 10617 Reauthorization Reauthorization is not DoReauthorization Capture the authorization not allowed allowed inside honor or reauthorize outside of period honor peri
113. the response body contains an Errors element with information to help you troubleshoot the cause of the error See Error Responses on page 22 26 The lt CorrelationID gt element contains information about the PayPal application that processed the request Use the value of this element if you need to troubleshoot a problem with one of your requests 27 through 30 The different PayPal APIs return different structures depending on their response definitions For detailed information see the description of the individual APIs NOTE Because a field is defined in the formal structure of an API response this does not mean that the field is necessarily returned Data are returned in a response only if PayPal has recorded data that corresponds to the field Related information Error Responses Error Responses If a request is malformed or contains some other error the body of the SOAP response contains an Errors element with other elements that can help you troubleshoot the cause of the error The structure of error messages are as follows August 2012 SOAP API Developer Reference PayPal SOAP API Basics a Error Responses Errorlype i E SeverityCodeType e ShortMessage string e LongMessage 0 1 string e ErrorCode token e SeverityCode SeverityCodeType ErrorParameterType ParamID string se e Value string e ErrorParameters 0 ErrorParameterType The most important of these additi
114. the token value appended https www paypal com cgi bin webscr cmd complete express checkout amp token token NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany 142 August 2012 SOAP API Developer Reference ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SuccessPageRedirect Requested BillingAgreement ID FMFDetails deprecated ShipAmount SellerId SellerUserName SellerRegistrationD ate xs boolean Flag to indicate whether you would like to redirect the buyer to sign up for PayPal after completing the transaction Tf set to true you can redirect users to the following URL with the token value appended https www paypal com cgi bin webscr cmd express checkout success amp token token xs string The ID of the billing agreement associated with the Express Checkout transaction ebl FMFDetailsType Fraud filter details This field is deprecated since version 63 0 Use FMFDetails in Payment InfoType instead xs string Amount of shipping charged on this transaction Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD xs string Unique non changing identifier for the merchant a
115. to eBay 10459 Error occurred in eBay API failure communicating to eBay 10460 Error occurred in Parsing error communicating to eBay 10461 Error occurred in Item number invalid removed or communicating to eBay unavailable 10462 Error occurred in Order not found communicating to eBay 10463 Error occurred in eBay user password incorrect communicating to eBay 10464 Error occurred in Item ID and Transaction ID communicating to eBay mismatch 10465 Error occurred in eBay user invalid communicating to eBay 10467 Error occurred in Duplicate Item ID communicating to eBay 10468 Transaction refused because Duplicate Order ID of an invalid argument See additional error messages for details 10469 PaymentAction of Order Express Auctions is unavailable Temporarily Unavailable 10470 Wowo flag is off for Solution Type passed as Sole while ExpressO feature ExpressO feature is turned off 10471 Transaction refused because ReturnURL is missing of an invalid argument See additional error messages for details 10472 Transaction refused because CancelURL is missing of an invalid argument See additional error messages for details 10473 Error occurred in Multiple Order IDs are not supported communicating to eBay August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10474 Invalid Data This transaction cannot be processed The country code in the
116. used if one exists IMPORTANT The notify URL applies only to DoExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters ns AddressType Optional Address to which the order is shipped ebl PaymentDetailsItemType Optional Details about each individual item included in the order ed EnhancedPaymentDataType Optional Enhanced Data section to accept channel specific data eBay xs string Optional Note to the merchant Character length and limitations 255 single byte characters xs string A per transaction description of the payment that is passed to the buyer s credit card statement NOTE Ignore when PaymentAction Order ns SellerDetailsType Optional Details about the merchant This information is used for emails sent out for eBay transactions xs string Optional Transaction identification number of the transaction that was created NOTE This field is only returned after a successful transaction for DoExpressCheckout has occurred xs string Optional The payment method type Specify the value InstantPaymentOnly 134 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description PaymentAction ebl PaymentActionCodeType How you want to obtain payment When implementing parallel payment
117. used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 PaymentlnfoTypeFields Field Description TransactionID ParentTransactionID ReceiptID TransactionType xs string Unique transaction ID of the payment Character length and limitations 17 single byte characters xs string Parent or related transaction identification number This field is populated for the following transaction types e Reversal Capture of an authorized transaction e Reversal Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionID is the original OrderID e Capture of an order authorization e Void of an order The value of ParentTransactionID is the original OrderID Character length and limitations 16 digits Only authorization of an order and capture of an order authorization apply to point of sale transactions xs string Receipt identification number Character length and limitations 16 digits Empty for point of sale transactions ns PaymentTransactionCodeType The type of transaction It is
118. version whenever possible Unless specifically specified API operations default to the latest version What s New in Version 92 0 Updated for 92 0 Added new MsgSubID field for the following APIs for both requests and responsees RefundTransaction DoReferenceTransaction DoAuthorization and DoCapture What s New in Version 89 0 Updated for 89 0 Added new field to SetExpressCheckout and DoReferenceTransaction Request APIs Added new error to DoReferenceTransaction Request API What s New in Version 88 0 Maintenance release updated for 88 0 What s New in Version 85 0 No new features added solely a maintenance release What s New in Version 84 0 SOAP API Developer Reference August 2012 375 a What s New in Version 84 0 New Field in RefundTransaction Response Field Description RefundInfo ebl RefundInfoType Contains refund payment status information This field is available since version 84 0 New RefundinfoType in RefundTransaction Response Field Description RefundStatus xs PaymentStatusCodeType Status of the refund It is one of the following values e instant e delayed This field is available since version 84 0 PendingReason xs PendingStatusCodeType Reason that the payment is delayed It is one of the following values e none The refund is instant e echeck The refund is delayed This field is available since version 84 0 New Field in DoReferenceTransa
119. 0002 Restricted account Account is restricted Your PayPal merchant account has been restricted Contact your PayPal account manager for resolution 10002 Authentication Authoriza API access is disabled for this tion Failed account SOAP API Developer Reference August 2012 287 API Error Codes Validation Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication Authoriza tion Failed 10006 Version error 10008 Security error 10101 This API Temporarily Unavailable Client certificate is disabled Version is not supported Security header is not valid This API is temporarily unavailable Please try later Validation Errors Validation Errors Error Code Short Message Long Message 81000 81001 81002 81003 81004 81100 81101 81102 81103 81104 81105 81106 81107 81108 81109 81110 81111 81112 81113 Missing Parameter Invalid Parameter Unspecified Method Unspecified Method Unspecified Method Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Required Parameter Missing Unable to identify parameter A Parameter is Invalid Unable to identify parameter Method Specified is not Supported No Method Specified No R
120. 012 SOAP API Developer Reference API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10713 10744 10748 10751 10752 10760 11089 11501 11502 11503 11504 11505 Invalid Data Invalid Data Invalid Data Invalid Data Gateway Decline Invalid Configuration Transaction Refused Invalid merchant country The token is missing or is invalid Missing subscription details Missing schedule details Start date should be greater than current date There s an error with this transaction Please enter a country in the billing address This transaction cannot be processed Please enter a valid country code in the billing address This transaction cannot be processed without a Credit Card Verification Number There s an error with this transaction Please enter a valid state in the billing address This transaction cannot be processed This transaction cannot be processed The country listed for your business address is not currently supported Account is locked or inactive The merchant s country is currently not supported The token is missing or is invalid Missing subscription details Missing schedule details Subscription start date should be greater than current date There was a problem with a particular field in the address The long error message tells you which field is invalid There was
121. 0431 Transaction refused because of an invalid argument See additional error messages for details A successful transaction has already been completed for this token PayPal allows a token only once for a successful transaction If you determine that your buyers are clicking your Place Order button twice PayPal recommends that you disable the button after your buyer has clicked it The currencies of the shopping cart amounts must be the same Express Checkout has been disabled for this merchant Please contact Customer Service Item total is invalid Shipping total is invalid Handling total is invalid Tax total is invalid Item amount is missing Item amount is invalid August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10432 10433 10434 10436 10437 10438 10439 10440 10441 10442 10446 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error message
122. 1 string subject string NOTE Not all fields shown are available for use Use only the fields described in the documentation 166 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation CENT GetTransactionDetails Response Message fe PaymentItemType InvoiceID 0 1 string e EbayItemTxnId 0 1 string Custom 0 1 string Name 0 1 string e Memo 0 1 string e Number 0 1 string e SalesTax 0 1 string e Quantity 0 1 string e PaymentItem 0 PaymentItemType e SalesTax 0 1 string e Subscription 0 1 SubscriptionInfoType e Shipping amp mount 0 1 string Auction 0 1 AuctionInfoType e HandlingAmount 0 1 string Amount 1 BasicAmountType e Options 0 OptionType SubscriptionInfoType reattempt string recurring string amp SubscriptionID string e SubscriptionDate 0 1 dateTime e EffectiveDate 0 1 dateTime e RetryTime 0 1 dateTime e Username 0 1 string Password 0 1 string Recurrences string e Terms 0 SubscriptionTermsType E AuctionInfoType multiltem string e BuyerID 0 1 string e ClosingDate 0 1 dateTime NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 167 pg GetTransactionDetails API Operation GetTransactionDetails Response Message 22 Subs
123. 10 No Funding Transaction failed because has no Payee has no funding sources funding sources 10211 Invalid MP ID Invalid MP ID 10212 Profile preference setting A profile preference is set to A profile preference is set that automatically deny certain automatically denies this kind of transactions transaction 10213 Invalid Soft Descriptor The soft descriptor passed in contains invalid characters 10214 Soft descriptor format error 10215 Soft Descriptor truncated The soft descriptor was truncated 10216 Confirmed address required Transaction refused because a Transaction refused because a confirmed address is not available confirmed address is not available August 2012 SOAP API Developer Reference API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10400 Transaction refused Order total is missing TotalOrder amount is missing because of an invalid argument See additional error messages for details 10401 Transaction refused Order total is invalid TotalOrder amount is invalid because of an invalid argument See additional error messages for details 10402 Authorization only is not This merchant account is not Merchant is not eligible for auth allowed for merchant permitted to set PaymentAction to settlement Authorization Please contact Customer Service 10406 Transaction refused The PayerID value is invalid Merchant account number is because of
124. 127 single byte alphanumeric characters xs string Optional An informational note about this settlement that is displayed to the buyer in email and in their transaction history Character length and limitations 255 single byte characters August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoCapture API Operation Field Description SoftDescriptor xs string Optional Per transaction description of the payment that is passed to the buyer s credit card statement If you provide a value in this field the full descriptor displayed on the buyer s statement has the following format lt PP PAYPAL gt lt Merchant descriptor as set in the Payment Receiving Preferences gt lt 1 space gt lt soft descriptor gt Character length and limitations The soft descriptor can contain only the following characters e Alphanumeric characters e dash e asterisk e period e space If you pass any other characters such as PayPal returns an error code The soft descriptor does not include the phone number which can be toggled between your customer service number and PayPal s Customer Service number The maximum length of the soft descriptor is 22 characters Of this the PayPal prefix uses either 4 or 8 characters of the data format Thus the maximum length of the soft descriptor information that you can pass in this field is 22 len PP PAYPAL gt len Descript
125. 178 273 TerminalID response field 34 278 377 379 Thai Baht 370 THB 370 ThreeDSecure request fields 66 ThreeDSecure response fields 70 ThreeDSecureRequest request field 57 Timestamp response field 285 Timezone response field 286 Token request field 106 128 192 238 240 Token response field 105 114 142 238 TotalBillingCycles response field 212 TotalRefundedAmount response field 279 TotalType request field 94 TransactionClass request field 283 TransactionEntity request field 40 TransactionID request field 40 161 183 276 282 TransactionId request field 98 134 TransactionID response field 41 68 78 145 173 184 268 286 TransactionId response field 122 125 TransactionSearch API operation 281 TransactionSearch request fields 282 TransactionSearch request message 281 TransactionSearch response fields 285 SOAP API Developer Reference TransactionSearch response message 285 TransactionTyp eresponse field 145 TransactionType response field 174 269 TrialPeriod request field 194 227 TrialPeriod Amount request field 196 229 TrialPeriod BillingFrequency request field 196 TrialPeriod BillingPeriod request field 196 TrialPeriod TotalBillingCycles request field 196 228 TRY 370 Turkish Lira 370 TWD 369 Type response field 286 U J S Dollar 370 pdateRecurringPaymentsProfile API operation 221 pdateRecurringPaymentsProfile request fields 225 pdateRecurringPaymentsProfile request message 221 pdateRecurringPayme
126. 258 Street2 response field 118 173 211 216 244 251 StreetMatch response field 29 SubscriberName request field 193 225 SubscriberName response field 211 SubscriberShipping Address request field 193 225 SubscriberShipping Address response field 211 Subscription response field 179 SubscriptionDate response field 180 SubscriptionID response field 180 181 SubscriptionInfoType response fields 180 SubscriptionTermsType response field 181 SubscriptionTermsType response fields 181 SuccessPageRedirectRequested response field 143 Suffix request field 60 Suffix requestfi eld 76 201 264 284 Suffix response field 117 172 244 250 SurveyChoice request field 94 SurveyChoiceSelected request field 130 SurveyChoiceSelected response field 116 170 SurveyEnable request field 94 SOAP API Developer Reference SurveyQuestion request field 94 130 SurveyQuestion response field 116 SurveyQuestionresponse field 170 Swedish Krona 369 370 Swiss Franc 369 370 T Taiwan New Dollar 369 Tax request field 64 100 136 203 262 383 Tax response field 123 Tax Amount request field 74 197 226 229 Tax Amount response field 146 175 213 270 TaxId request field 104 TaxId response field 126 TaxIdDetails request field 102 TaxIdDetailsType request fields 104 TaxIdDetailsType response fields 126 TaxIdType request field 104 TaxIdType response field 126 Tax Total request field 62 97 133 260 Tax Total response field 121 Terminalld 150
127. 270 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description FeeAmount ebl BasicAmountType PayPal fee amount charged for the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SettleAmount ebl BasicAmountType Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TaxAmount ebl BasicAmountType Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ExchangeRate xs string Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buye
128. 4 10004 10007 10007 11002 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Permission denied Permission denied Search warning Receipt id is not valid Payer email is invalid Auction item id is not valid Receiver email is invalid You can not search for a transaction id and a receipt id Receiver can only be specified for payments you ve received The transaction id is not valid You do not have permission to search for this transaction You do not have permission to make this API call The number of results were truncated Please change your search parameters if you wish to see all your results 332 August 2012 SOAP API Developer Reference API Error Codes RefundTransaction API Errors RefundTransaction API Errors RefundTransaction API Errors Error Code Sho
129. 64 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 Is 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 Paymentltem response field 179 PaymentltemInfo response field 170 PaymentltemInfoType response fields 178 PaymentltemType 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 P
130. API Basics SOAP Service Enapoints RequesterCredentials Authentication Elements in SOAP Header Element Value Description Username api username Your API username which is auto generated by PayPal when you apply for a digital certificate to use the PayPal SOAP API You can see this value on https www paypal com in your Profile under API Access gt API Certificate Information Password api password Your API password which you specify when you apply for a digital certificate to use the PayPal SOAP API Signature api signature Your API signature if you use one instead of an API Certificate Subject authorizing The email address of a third party for whom you are sending account _ requests to the PayPal SOAP API Your API username must have emailaddress been granted permission by this third party to make any particular PayPal API request Related information Request Structure SOAP Service Endpoints Depending on your chosen authentication mechanism your SOAP requests must be processed by different service endpoints SOAP Service Endpoints Authentication Mechanism Live Production Endpoint Test Sandbox Endpoint API Signature https api 3t paypal com 2 0 https api 3t sandbox paypal com 2 0 API Certificate https api paypal com 2 0 https api sandbox paypal com 2 0 SOAP Request Envelope The following diagram illustrates the contents of a PayPal SOAP request envelope All Pa
131. API Operation CreditCardDetailsType e CreditCardType 0 1 CreditCardTypeType e CreditCardNumber 0 1 string ExpMonth 0 1 int ExpYear 0 1 int CardOwner 0 1 PayerInfoType e cvv2 0 1 string StartMonth 0 1 int Start Year 0 1 int IssueNumber 0 1 string ThreeDSecureRequest 0 1 ThreeDSecureRequestType RecurringPaymentsProfileDetailsType e SubscriberName 0 1 string e SubscriberShippingAddress 0 1 AddressType 1 1 dateTime 0 1 string e BillingStartDate ProfileReference fe ScheduleDetailsType Description 1 1 string TrialPeriod 0 1 BilingPeriodDetailsType e PaymentPeriod 1 1 BilingPeriodDetailsType e MaxFailedPayments 0 1 int ActivationDetails 0 1 ActivationDetailsType AutoBilOutstanding mount 0 1 AutoBillType Not all fields shown are available for use fe PaymentDetailsItemType e Name 0 1 string e Number 0 1 string e Quantity 0 1 integer e Tax 0 1 BasicAmountType Amount 0 1 BasicAmountType e EbayltemPaymentDetailsltem 0 1 EbayltemPaymentDetailsltemType PromoCode 0 1 string e ProductCategory 0 1 ProductCategoryType Description 0 1 string e ItemWeight
132. BasicAmountType 3 currencyID E ExaressChockoutTokciTyp gt CurrencyCodeType E Address Iype e Name 0 1 string t Street 0 1 string streetz U 1 string E CityName 0 1 string e StateOrProvince 0 1 string amp Country 0 1 CountryCodeTyps Count yName 0 1 string e Phone 0 1 string Postal ode 0 1 string e AddressIC 0 1 string e AddressOwner 0 1 AddressownerCcdaType e External ddressID 0 1 string e InternationalName 0 1 string e InternationalSteteAndcity 0 1 string le Inter aliuaSuzet 0 1 skrin e AddressStatus 0 1 AddressstatusCodeType E PaymentActionCodeType E souton ypel ype E LandingPageType E Erail ddressType TII E ChamelType Es Biling greementDetailsType e BillingType lel BilinghgreementDescription 0 1 string 0 1 MerchantPullPaymentCodeType 0 1 string 1 1 BilincCcdeType PaymentType Billing greementCustom E ProductCategor Type E ShppingServiceCodeType E FuncingSourceDetailsType alloweushrunding L 12 string e Userselec edFunding5ourze C 1 UserselectedFundingSourceType E OtherPaymen MethodDstailsType e OtherPaymentfvethodId 1 string e OtherPaymentiethoJType 1 string le OtherPaymentethodLabal 1 string e OtherPaymentfethodLabaIDescripton 1 string E OtherPaymentiethodl angDesrintianTitle n 1 string e Oth
133. D is not supported 10007 Permission denied You do not have permission to make this API call SOAP API Developer Reference August 2012 305 306 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10010 Invalid Invoice Non ASCII invoice id is not supported 10101 Option not supported Express Checkout temporarily unavailable Please try later 10102 Payment Action of Order PaymentAction of Order is Temporarily Unavailable temporarily unavailable Please try later or use other Payment Action 10103 Please use another Solution Your Solution Type is temporarily Type unavailable If possible please use another Solution Type 10400 Transaction refused because OrderTotal is missing of an invalid argument See additional error messages for details 10401 Transaction refused because Order total is invalid of an invalid argument See additional error messages for details 10402 Authorization only is not This merchant account is not allowed for merchant permitted to set PaymentAction to Authorization Please contact Customer Service 10404 Transaction refused because ReturnURL is missing of an invalid argument See additional error messages for details 10405 Transaction refused because CancelURL is missing of an invalid argument See additional error messages for details 10407 Transaction refused because Invalid buyer email address of an invalid argument See Buy
134. DetailLevel 0 DetailevelCodeType ErrorLanguage 0 1 string Version string PE any 0 1 ie DoExpressCheckoutPaymentRequestType Af DoExpressCheckoutPaymentRequestDetails 1 1 DoExpressCheckoutPaymentRequestDetailsType ReturnFMFDetails 0 1 int e o DoExpressCheckoutPaymentRequestDetailsType PaymentAction Token PayerID OrderURL PaymentDetails PromoOverrideFlag e PromoCode o e EnhancedData SoftDescriptor UserSelectedOptions GiftMessage GiftReceiptEnable GiftWrapName GiftWrap mount BuyerMarketingEmail SurveyQuestion SurveyChoiceSelected ButtonSource 0 gcovcovcuuovovoHuuuuuvoggt g gt bn mn ot en t gt 1 PaymentActionCodeType ExpressCheckoutTokenType UserIDType string PaymentDetailsType string string EnhancedDataType string UserselectedOptionType string string string BasicAmountType string string string string NOTE Not all fields shown are available for use Use only the fields described in the documentation 126 August 2012 SOAP API Developer Reference e PaymentAction Token PayerID e OrderURL PaymentDetails e PromoOverrideFlag PromoCode e EnhancedData e SoftDescriptor s e UserSelectedOptions e GiftMessage GiftReceiptEnable e GiftWrapMame Giftwrap
135. Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set currencyId to GBP In addition you must specify either StartMonth and Start Year or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters CreditCardNumber xs string Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type ExpMonth xs int Required Credit card expiration month Character length and limitations 2 single byte numeric characters including leading zero ExpYear xs int Required Credit card expiration year Character length and limitations 4 single byte numeric characters CVV2 xs string Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits CardOwner ns PayerInfoType Required Details about the owner of the credit card StartMonth xs int Optional Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary 58 August 2012 SOAP API Developer Reference DoDirectPayment API Operation
136. DoAuthorization API Operation DoAuthorization API Operation Authorize a payment DoAuthorization Request Message te AbstractRequestType TransactionEntityType e Detaillevel 0 DetailLevelCodeType e ErrorLanguage 0 1 string ts BasicAmountType 3 currencylD CurrencyCodeType e Version string fe any 0 1 DoAuthorizationRequestType e TransactionID 1 1 string e TransactionEntity 0 1 TransactionEntityType e Amount 1 1 BasicAmountType e MsgSubID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation DoAuthorization Request Fields Field Description TransactionID xs string Required Value of the order s transaction identification number returned by PayPal Character length and limitations 19 single byte characters Amount ebl BasicAmountType Required Amount to authorize Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TransactionEntity ebl TransactionEntityType Optional Type of transaction to authorize The only allowable value is Order which means that the transaction represents a buyer order that can be fulfilled over 29 days 40 August 2012 SOAP API Developer Reference Aut
137. DoDirectPayment Response Message DoDirectPayment Response Message b AbstraciRasponse Type e e Timestamp 0 1 dateTime el Ack AckCodeType Transactionld e CorrelationID 0 1 string Errors 0 4 ErrorType PendingStatusCodeType el Version string l Build string PaymentStatusCodeType f any 0 1 i FMFDetails Type el AcceptFilters 0 1 RiskFilterListType e PendingFilters 0 11 RiskFilterListType E DoDirectPaymentResponseType e DenyFilters 0 1 RiskFilterListType e ReportFilters 0 1 RiskFilterListType e Amount 1 1 e AvSCode 1 1 string E CVV2Code 1 1 string ThreeDSecureResponseType e TransactionID 1 1 Transactionld el Vpas 0 1 string e PendingReason 0 1 PendingStatusCodeType e EciSubmitted3D5 0 1 string e PaymentStatus 0 1 PaymentStatusCodeType le FMFDetails 0 1 FMFDetailsType e ThreeDSecureResponse 0 1 ThreeDSecureResponseType e PaymentAdviceCode 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation E RiskFilterListType E FMFDetailsType e AcceptFillers 0 1 RiskFilterListType e PendingFilters 0 1 RiskFilterListType e DenyFilters 0 1 RiskFilterListType e ReportFilters 0 1 RiskFilterListType see e Filters 1 RiskFilterDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation
138. Frequency TrialPeriod TotalBi llingCycles TrialPeriod Amount ShippingAmount ns BillingPeriodType Unit for billing during this subscription period required if you specify an optional trial period It is one of the following values e Day e Week e SemiMonth e Month e Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year xs int Number of billing periods that make up one billing cycle required if you specify an optional trial period The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 xs int Optional Number of billing cycles for trial payment period cc BasicAmountType Billing amount for each billing cycle during this payment period required if you specify an optional trial period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator m
139. I Developer Reference Recurring Payments and Reference Transactions API Operations 12 SetCustomerBillingAgreement API Operation Field Description BillingAgreement xs string Description Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer is billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters PaymentType ns MerchantPullPaymentCodeType Optional Type of PayPal payment you require for the billing agreement It is one of the following values e Any e InstantOnly NOTE For recurring payments this field is ignored BillingAgreement xs string Custom Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes SetCustomerBillingAgreement Response Message AbstractResponseType ExpressCheckoutTokenType gt Timestamp 0 1 dateTime e Ack AckCodeType CorrelationID 0 1 string el Errors 0 ErrorType gt Version string e Build string any E SetCustomerBillingAgreementResponseType ses e Token ExpressCheckoutTokenType NOTE Not all fields shown are available for use Use only the fields desc
140. I Developer Reference Recurring Payments and Reference Transactions API Operations 12 CreateRecurringPaymentsProfile API Operation E RecurringPaymentsProfileDetailsType e SubscriberName 0 1 string e SubscriberShipping ddress 0 1 AddressType e BilingStartDate 1 1 dateTime ProfileReference 0 1 string e Name Streeti e Street2 e CityName e StateOrProvince HE Country HF CountryName e Phone e PostalCode e AddressID e AddressOwner e External ddressID e InternationalName e InternationalStreet e AddressStatus E AddressType 0 0 0 0 0 0 0 0 0 0 0 0 0 InternationalstateAndCity 0 0 0 string string string string string CountryCodeType string string string string AddressOwnerCodeType string string string string AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation e Description 1 1 string e TrialPeriod 0 1 BillingPeriodDetailsType e PaymentPeriod 1 1 BillingPeriodDetailsType e MaxFailedPayments 0 1 int e ActivationDetails 0 1 ActivationDetailsType e AutoBillOutstanding mount 0 1 AutoBilType BillingPeriodDetailsType BillingPeriod Amount TaxAmount Initial mount E AutoBillType BilingFrequency 1 TotalBilingCycles
141. IANA GF FRENCH POLYNESIA PF FRENCH SOUTHERN TERRITORIES TF GABON GA GAMBIA GM GEORGIA GE GERMANY DE GHANA GH GIBRALTAR GI GREECE GR GREENLAND GL GRENADA GD GUADELOUPE GP GUAM GU GUERNSEY GG GUYANA GY HEARD ISLAND AND MCDONALD ISLANDS HM HOLY SEE VATICAN CITY STATE VA HONDURAS HN HONG KONG HK HUNGARY HU ICELAND Is INDIA IN INDONESIA ID IRELAND IE ISLE OF MAN IM ISRAEL IL ITALY IT JAMAICA JM SOAP API Developer Reference August 2012 359 UE Countries and Regions Supported by PayPal Country or Region Country or Region Code JAPAN JP JERSEY JE JORDAN JO KAZAKHSTAN KZ KIRIBATI KI KOREA REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LATVIA LV LESOTHO LS LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA MK MADAGASCAR MG MALAWI MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX MICRONESIA FEDERATED STATES OF FM MOLDOVA REPUBLIC OF MD MONACO MC MONGOLIA MN MONTENEGRO ME MONTSERRAT MS 360 August 2012 SOAP API Developer Reference Countries and Regions Supported by PayPal m Country or Region Country or Region Code MOROCCO MA MOZAMBIQUE MZ NAMIBIA NA NAURU NR NEPAL NP NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PALAU PW PALESTINE PS PANAMA PA PARAGUAY PY PERU PE PHILIPPINES
142. IPN message is sent to the merchant when the specified number of failed payments is reached Character length and limitations Number string representing an integer AutoBillOutstanding mns AutoBillType Amount Optional Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid It is one of the following values e NoAutoBill PayPal does not automatically bill the outstanding balance e AddToNextBilling PayPal automatically bills the outstanding balance 194 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 CreateRecurringPaymentsProfile API Operation BillingPeriodDetailsType Fields Field Description PaymentPeriod Billi ns BillingPeriodType ngPeriod Required Unit for billing during this subscription period It is one of the following values e Day Week SemiMonth Month Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year PaymentPeriod Billi xs int ngFrequency Required Number of billing periods that make up one billing cycle The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the
143. IncentiveInfoType RegInstrumentDetails 0 1 string ExternalRememberMeOptInDetais 0 1 ExternalkememberMeOptInDetailsType FlowControlDetails 0 1 FlowControlDetailsSType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 81 82 ExpressCheckout API Operations SetExpressCheckout API Operation E SetExpresscheckostRequestDetaibTy2e GrderTotal e ReturnURL CancelURL e tackinglmageURL gropaySuccessURL gropayCancelURL BanktxnPendingURL Token E Hax amp mount GrderDescriation Custam InvoiceID ReqConfirmShipping Regeilling ddress 8 BillingAddrsss koShipping e 4ddressOverride LacaleCods PageStyle cop header Image cop header border color t cop header back coor cop payflcw color 8 cop cart border color cop logo image e address E PaymentAztion e solutionType e LandingPage e BuyerEmai e ChannelTyp gt e BlliniyAyre en Del ails e PromoCodss e PayPalCheckOutBtnType ProductCategory e ShippingMethod Prulile amp uu essClHiarigeDaLe e dllowNote E FundingSourceDetais e rrandNam gt CallbackURL e EnhancedCheckoutDCata e GtherPaynentMethods 8 BuyerDeteils e PaymentDatails e RatRateShippingOptions e Call
144. InternationalStateAndcity 0 1 string InternationalStreet 0 1 string AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation E CreditCardTypeType E PayerInfoType CreditCardType CreditCardNumber 41 string CreditCardTypeType ExpMonth e ExpYear e CardOwner int int PayerInfoType e Payer e PayerID e PayerStatus 0 0 0 Email amp ddressType UserIDType PayPalUserStatusCodeType e PayerName e PayerCountry 0 e PayerBusiness 0 1 string e Address 0 PersonNameType e cwz 1 string e StartMonth 41 int StartYear 41 int CountryCodeType IssueNumber 1 string AddressType e ThreeDSecureRequest 0 e ContactPhone 0 1 string ThreeDSecureRequestType e Eci3ds 1 string e Cavv 1 string e xid 41 string e Mpivendor3ds 0 1 string e AuthStatus3ds 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 207 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation E EmailAddressType e Payer Email ddressType PayerID 41 UserIDType E UserIDType e PayerStatus 0 1 PayPalUserStatusCodeType PayerName PersonNam
145. LBaseComponents gt Error lt SeverityCode gt SOAP API Developer Reference August 2012 23 24 PayPal SOAP API Basics CorrelationID for Reporting Problems to PayPal lt Errors gt CorrelationID xmlns urn ebay apis eBLBaseComponents gt debugging info lt CorrelationID gt Version xmlns urn ebay apis eBLBaseComponents gt 1 000000 lt Version gt Build xmlns urn ebay apis eBLBaseComponents gt 1 0006 lt Build gt other elements in response lt SOAP ENV Body lt SOAP ENV Envelope Related information Response Structure CorrelationID for Reporting Problems to PayPal The value returned in CorrelationID is important for PayPal to determine the precise cause of any error you might encounter If you have to troubleshoot a problem with your requests we suggest that you capture the value of CorrelationID so you can report it to PayPal UTF 8 Character Encoding The PayPal API assumes that all data in requests is in Unicode specifically the Unicode or UCS Transformation Format 8 bit encoding form UTF 8 In responses the API always returns data in UTF 8 Date Time Formats The PayPal SOAP API schema defines date time values as Coordinated Universal Time UTC GMT using ISO 8601 format and of type ns dateTime An example date time stamp is 2006 08 24T05 38 48Z Core Currency Amount Data Type The core currency amount data type is called BasicAmountType and is derived from strin
146. Maestro card was issued Character length and limitations 4 digits IssueNumber xs string Issue number of Maestro card Character length and limitations 2 numeric digits PayerlnfoType Fields Field Description Payer ns EmailAddressType Email address of buyer Character length and limitations 127 single byte characters FirstName ns PersonNameType Buyer s first name Character length and limitations 25 single byte characters LastName ns PersonNameType Buyer s last name Character length and limitations 25 single byte characters Address ns AddressType Buyer s billing address information AddressType Fields Field Description AddressOwner ebl AddressOwnerTypeCode eBay company that maintains this address It is one of the following values e eBay e PayPal SOAP API Developer Reference August 2012 215 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description AddressStatus Name Streetl Street2 CityName StateOrProvince PostalCode Country CountryName Phone ebl AddressStatusTypeCode Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed xs string Person s name associated with this address Character length and limitations 32 single byte characters xs string First street address Character length and limitations 100 sin
147. Message Long Message Correcting This Error 10004 Transaction refused because Invalid eBay seller feedback total of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback recent of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback recent of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay item transaction date of an invalid argument See additional error messages for details 10004 Transaction refused because Invalid eBay item buyer protection of an invalid argument See type additional error messages for details 10004 Transaction refused because Invalid eBay item payment hold risk of an invalid argument See additional error messages for details 10004 Transaction refused because Multiple eBay order IDs not allowed of an invalid argument See additional error messages for details 10004 Transaction refused because AllowPushFunding value specified is of an invalid argument See invalid It must be 0 or 1 or an empty additional error messages for string details 10005 Option not supported Merchant not enabled to use enhanced checkout data 10005 Option not supported Merchant not enabled to use OtherPaymentMethodDetails 10005 Option not supported Transaction I
148. OAP API Developer Reference August 2012 225 Fe Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description Amount ShippingAmount TaxAmount OutstandingBalance AutoBillOutstanding Amount cc BasicAmount Type Optional Billing amount for each cycle in the subscription period not including shipping and tax amounts NOTE For recurring payments with Express Checkout the payment amount can be increased by no more than 20 every 180 days starting when the profile is created Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma cc BasicAmount Type Optional Shipping amount for each billing cycle during the regular payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma cc BasicAmount Type Optional Tax amount for each billing cycle during the regular payment period NOTE All amounts in the request must have the same currency Chara
149. OAP ENV Header gt lt SOAP ENV Body specific api name Req xmlns urn ebay api PayPalAPI gt specific api name Request Version xmlns urn ebay apis eBLBaseComponents Service version lt Version gt required or optional fields xsi type some type here gt data lt required or optional fields gt specific api name Request specific api name Req SOAP ENV Body SOAP ENV Envelope Annotation of Generic SOAP Request Lines Comment 12 13 The Username and Password fields are part of the PayPal SOAP API lt RequesterCredentials gt security authentication mechanism you must construct for every SOAP request header 14 The Signature element should include your API signature string if that is the kind of API credential you are using 15 The Subject element can specify a third party PayPal account by whom you are authorized to make this request 19 through 27 The SOAP request for every PayPal API follows this element naming pattern The API s specific name is appended with Req and in this element the specific api name Request is nested Each specific api name Request has a corresponding specific api name RequestType 22 The number of the PayPal SOAP API version is required on each SOAP request This version number is the value of ns versionin https www paypal com wsdl PayPalS vc wsdl 24 For details about required and optional elements and values for specific requests see the
150. OTE Not all fields show are available for use Use only the fields described in the documentation a AbstractResponseType e Timestamp 0 1 dateTime e Ack AckCodeType e CorrelationID 0 1 string e Errors 0 ErrorType Version string e Build string e any BAUpdate vea TE BAUpdateResponseDetails ResponseType BALlpdateResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation 246 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations BAUpdate API Operation BAUpdateResponseDetailsType E MerchantPullStatusCodeType e Biling amp greementID 1 1 string E PayerInfoType e Biling amp greementDescription 0 1 string Payer 0 1 Email ddressType e Biling amp greementStatus 1 1 MerchantPullStatusCodeType Billing amp greementCustom 0 1 string PayerID 1 UserIDType e PayerInfo 1 1 PayerInfoType e Biling amp greementMax 0 1 BasicAmountType PayerStatus 0 1 PayPalUserStatusCodeType PayerName PersonNameType PayerCountry 0 1 CountryCodeType PayerBusiness 0 string Address 0 1 AddressType ContactPhone 0 1 string fe BasicAmountType a currencyID CurrencyCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012
151. Operation Field Description Custom deprecated InvoicelD deprecated ReturnURL CancelURL CallbackURL CallbackTimeout xs string Optional A free form field for your own use such as a tracking number or other value you want PayPal to return on GetExpressCheckoutDetails response and response Character length and limitations 256 single byte alphanumeric characters This field is deprecated since version 53 0 Use Custom in PaymentDetailsType instead xs string Optional Your own unique invoice or tracking number PayPal returns this value to you on DoExpressCheckoutPayment response If the transaction does not include a one time purchase this field is ignored Character length and limitations 127 single byte alphanumeric characters This field is deprecated since version 53 0 Use InvoicelD in PaymentDetailsType instead xs string Required URL to which the buyer s browser is returned after choosing to pay with PayPal For digital goods you must add JavaScript to this page to close the in context experience NOTE PayPal recommends that the value be the final review page on which the buyer confirms the order and payment or billing agreement Character length and limitations 2048 single byte characters xs string Required URL to which the buyer is returned if the buyer does not approve the use of PayPal to pay you For digital goods you must add JavaScript to this page to close the in cont
152. Optional Amount of discount associated with this Loyalty Card incentive NOTE Use character string as shown SOAP API Developer Reference August 2012 179 pe GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description LoyaltyCardDiscount xs string Currency Optional Currency of the loyalty card discount for example a 3 character currency code NOTE Use character string as shown Amount ebl BasicAmountType Cost of item Options ns OptionType name xs string value xs string PayPal item options for shopping cart AuctionInfoType Fields Field Description BuyerID xs string Buyer s auction ID ClosingDate xs string Auction s close date Multiltem xs string Counter used for multi item auction payments SubscriptionInfoType Fields Field Description SubscriptionID xs string ID generated by PayPal for the subscriber Character length and limitations No limit SubscriptionDate xs dateTime Subscription start date EffectiveDate xs dateTime Date when the subscription modification is effective RetryTime xs dateTime Date PayPal retrys a failed subscription payment 180 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description UserName Password Recurrences reattempt recurring SubscriptionTermsTy pe xs string Username that Pa
153. Optional Cost of item NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Number xs string Optional Item number Character length and limitations 127 single byte characters Quantity xs integer Optional Item quantity Character length and limitations Any positive integer Tax ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma EbayItemPayment eBl ebayItemPaymentDetailsItemType DetailsItem Optional Information relating to an auction sale on eBay August 2012 SOAP API Developer Reference DoDirectPayment API Operation am DoDirectPayment Request Message EbayltemPaymentDetailsltemType Fields Field Description ItemNumber AuctionTransaction Id OrderID xs string Optional A
154. P incentive no longer There s a problem with the available redemption code s you entered and can t be used at this time Your payment has not been processed Please go back to PayPal so that the code s can be removed your order total can be updated and then you ll be able to complete checkout 12126 Payment could not be We re having problems processed at this time processing redemption codes at Incentive temporarily this time Your payment has unavailable not been processed You can try to check out again at a later time or complete your payment without the discount applied 12201 Immediate Payment item The item specified is either not Please check that the item is a valid was not found valid or is not currently Immediate Payment item available for purchase as an Immediate Payment item 12203 Payment rolled back Payment was not created because of pending item because it would have been in pending state which is unacceptable for Immediate Payment items 12204 Transaction reversed Error occurred causing transaction reversal 12206 The value of Order and Authorization are PaymentAction must be not acceptable values for Sale for Immediate PaymentAction when the item Payment item is an Immediate Payment 12207 Cart ID is required for Cart ID is required for Immediate Payment item Immediate Payment item 12208 eBay item amount does eBay item amount does not not match Express match Express Checkout API Checkout API item item amount
155. PI Developer Reference API Error Codes GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10001 ButtonSource value The transaction could not be loaded truncated 10001 ButtonSource value The transaction could not be loaded truncated 10003 Missing argument OtherPaymentMethodID is missing 10003 Missing argument OtherPaymentMethodLabel is missing 10003 Missing argument OtherPaymentMethodType is missing 10003 Missing argument One or more of these giropay URLs is missing giropaySuccessURL giropayCancelURL BanktxnPendingURL 10004 Transaction refused because Transaction refused because of an of an invalid argument See invalid argument See additional error additional error messages for messages for details details 10004 Transaction refused because The transaction id is not valid of an invalid argument See additional error messages for details 10004 Invalid transaction type You can not get the details for this type of transaction 10004 Transaction refused because The transaction could not be loaded of an invalid argument See additional error messages for details 10004 Transaction refused because The transaction id is not valid of an invalid argument See additional error messages for details
156. PI Operation 183 ManagePendingTransactionStatus Request Message vr 183 ManagePendingTransactionStatus Request Fields 183 ManagePendingTransactionStatus Response Message ills 184 ManagePendingTransactionStatus Response Fields 184 Chapter 11 MassPay API Operation 185 MassPay Request Message vr vr kn ran 185 MassPay Request Fields less 185 MassPay Response Message 2 186 MassPay Response Fields 0 o ee 186 Chapter 12 Recurring Payments and Reference Transactions API Operations187 CreateRecurringPaymentsProfile API Operation 00000008 187 CreateRecurringPaymentsProfile Request Message 0 187 CreateRecurringPaymentsProfile Response Message 203 GetRecurringPaymentsProfileDetails API Operation 204 GetRecurringPaymentsProfileDetails Request Message 204 GetRecurringPaymentsProfileDetails Response Message 205 ManageRecurringPaymentsProfileStatus API Operation 217 ManageRecurringPaymentsProfileStatus Request Message 217 ManageRecurringPaymentsProfileStatus Response Message 218 BillOutstandingAmount API Operation L 2 2 arr rar kr kran aa 219 BillOutstandingAmount Request Message nrk eee eee 219 BillOutstandingAmount Response Messag
157. PI Operations 12 DoReferenceTransaction API Operation PaymentDetailsType Fields Field Description OrderTotal ebl BasicAmount Type Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to O 1f the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to 0 purchase specific fields are ignored NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ItemTotal ebl BasicAmountType Optional Sum of cost of all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2
158. PayPal SOAP API Developer Reference SOAP API Developer Reference Document Number 100002 en US 201208 O 2012 PayPal Inc All rights reserved PayPal is a registered trademark of PayPal Inc The PayPal logo is a trademark of PayPal Inc Other trademarks and brands are the property of their respective owners The information in this document belongs to PayPal Inc It may not be used reproduced or disclosed without the written approval of PayPal Inc Copyright O PayPal All rights reserved PayPal S r l et Cie S C A Soci t en Commandite par Actions Registered office 22 24 Boulevard Royal L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein PayPal Inc reserves the
159. Profile response An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile API Operation The UpdateRecurringPaymentsProfile API operation updates a recurring payments profile UpdateRecurringPaymentsProfile Request Message I AbstractRequestType fe UpdateRecurringPaymentsProfileRequestDetailsType DetailLevel 0 DetailLevelCodeType e ProfileID 1 1 string ErrorLanguage 0 1 string e Note string Version string Description 1 string FE any 0 1 e SubscriberName 1 string SubscriberShippingAddress 1 AddressType e ProfileReference A string e AdditionalBillingCycles A int UpdateRecurringPaymentsProfileRequestType El Amount 1 BasicAmountType UpdateRecurringPaymentsProfileRequestDetails UpdateRecurringPaymentsProfileRequestDetailsType e ShippingAmount BasicAmountType e TaxAmount 1 BasicAmountType e OutstandingBalance 1 BasicAmountType e AutoBillOutstandingAmount i AutoBillType A int i CreditCardDetailsType MaxFailedPayments CreditCard e 5 8 9898 PS SSeS 9 8 9 8 el BillingStartDate i dateTime e TrialPeriod 1 BilingPeriodDetailsType Update e PaymentPeriod 1 BilingPeriodDetailsTyp
160. ReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 DoVoid API Operation Void an order or an authorization DoVoid Request Message AbstractRequestType e DetailLevel 0 DetaillevelCodeType e ErrorLanguage 0 1 string amp Version string PE any 0 1 DoYoidRequestType e AuthorizationID string e Note 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation 48 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoVoid API Operation DoVoid Request Fields Field Description AuthorizationID xs string Required Original authorization ID specifying the authorization to void or to void an order the order ID IMPORTANT If you are voiding a transaction that has been reauthorized use the ID from the original authorization and not the reauthorization Character length and limitations 19 single byte characters Note xs string Optional Informational note about this void that is displayed to the buyer in email and in their transaction history Character length and limitations 255 single byte characters
161. There was a problem with a particular transaction Please enter a valid field in the address The long error postal code in the billing address message tells you which field is invalid 10718 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city and state in the billing message tells you which field is invalid address 10719 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error shipping address message tells you which field is invalid 10720 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address1 in the shipping address message tells you which field is invalid 10721 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address2 in the shipping address message tells you which field is invalid 10722 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city in the shipping address message tells you which field is invalid 10723 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The lon
162. Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set currencyId to GBP In addition you must specify either StartMonth and Start Year or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters CreditCardNumber xs string Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type ExpMonth xs int Required Credit card expiration month Character length and limitations 2 single byte numeric characters including leading Zero ExpYear xs int Required Credit card expiration year Character length and limitations 4 single byte numeric characters CVV2 xs string Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits CardOwner ns PayerInfoType Required Details about the owner of the credit card StartMonth xs int O
163. abetic characters This field is deprecated Use PaymentAction in PaymentDetailsType instead 128 August 2012 SOAP API Developer Reference ExpressCheckout API Operations mI DoExpressCheckoutPayment API Operation Field Description PayerID ebl UserIDType Required Unique PayPal buyer account identification number as returned in the GetExpressCheckoutDetails response Character length and limitations 13 single byte alphanumeric characters PaymentDetails ebl PaymentDetailsType Required Information about the payment UserSelectedOptions ebl UserSelectedOptionsType Optional Shipping options and insurance selected by the buyer ReturnFMFDetails xs boolean Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details GiftMessage xs string Optional The gift message the buyer entered on the PayPal pages Character length and limitations 150 single byte characters GiftReceiptEnable xs string Optional Whether the buyer selected a gift receipt on the PayPal pages It is one of the following vaues e true The buyer selected a gift message e false The buyer did not select a gift message GiftWrapName xs string Optional Return the gift wrap name only if the buyer selected the gift option on the PayPal pages Character lengt
164. action Please enter a valid in the United States or Canada but the state in the billing address state provided is not a valid state in either country 10752 Gateway Decline This transaction cannot be The transaction was declined by the processed issuing bank not PayPal The merchant should attempt another card 10754 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 10755 Invalid Data This transaction cannot be The currency code entered by the processed due to an unsupported merchant is not supported currency 10756 Gateway Decline The transaction cannot be None This is a PayPal internal error processed The country and billing address associated with this credit card do not match 10758 Invalid Configuration There s been an error due to The API username or password is invalid API username and or password incorrect for this merchant August 2012 SOAP API Developer Reference API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10759 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Please enter a valid Contact PayPal for more information credit card number and type 10760 Invalid Configuration This transaction cannot be The merchant s country of residence processed The country listed for listed in their PayPal account is not your business a
165. action Id is not valid Merchant not enabled for reference transactions ReferenceID field is empty Reference id refers to an invalid transaction This merchant is not enabled for Mark reference transaction DoReferenceTransaction Errors All Reference Transactions Related API Errors Error Code Short Message Long Message Additional Information 10001 10002 10003 10004 10004 10004 Internal Error Authentication Authorizati on Failed Missing argument Transaction refused because of an invalid argument See additional error messages for details Cart item calculation mismatch Tax calculation mismatch Internal Error Item name amount and quantity are required if item category is provided You are not signed up to accept payment for digitally delivered goods Cart item calculation mismatch The regular non trial billing period amount is different than the sum of the amounts for each item in the cart Tax calculation mismatch The tax amount for the regular non trial billing period is different than the sum of the tax for each item in the cart Scenario Merchant passes item category as either Digital or Physical but does not also pass one of the following parameters name amount or quantity Scenario Merchant is not signed up for digital goods but passes item category as Digital Scenario When the regular non trial billing period amount is different th
166. actionDetails Response Message Field Description InsuranceOptionSele cted ShippingOptionIsDef ault ShippingOptionName ShippingOpt ionAmoun t GiftMessage GiftReceiptEnable GiftWrapName xs boolean Whether the buyer selected the insurance option It is one of the following values e true The buyer selected Yes for the insurance option e false The buyer did not select the insurance option The option is No The value true is returned if the buyer selected the option Otherwise false is returned xs boolean Default shipping option displayed on the PayPal pages This field is required if you specify the Callback URL It is one of the following values e true This is the default flat rate shipping option PayPal displays this option by default e false This flat rate shipping option is not displayed as the default NOTE There must be ONE and ONLY ONE default It is not OK to have no default xs string Internal name of the shipping option such as Air Ground Expedited and so forth This field is required if you specify the Callback URL Character length and limitations 50 character string ebl BasicAmountType Amount of the flat rate shipping option This field is required if you specify the Callback URL Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separat
167. alue should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to O if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to O purchase specific fields are ignored NOTE You must set the currencylD attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Sum of cost of all items in this order For digital goods this field is required NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Optional Total shipping costs for this order NOTE You must set the currency1D attribute to one of the 3 character currenc
168. ame 0 1 PersonNameType eee e Billing amp ddress 0 1 AddressType le Cv v2 0 1 string le StartMonth 0 1 int e StartYear 0 1 int e IssueNumber 0 1 string E SenderDetails Type e DeviceDetails 0 1 DeviceDetails Type NOTE Not all fields shown are available for use Use only the fields described in the documentation 252 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReference Transaction API Operation E PaymentDetails Type e OrderTotal 0 1 e ItemTotal 0 1 B e ShippingTotal 0 1 e HandlingTotal 0 1 O e TaxTotal 0 1 e OrderDescription 0 1 string O e Custom 0 1 string e e InvoicelD 0 1 string e ButtonSource 0 1 string B AUSSI e NotifyURL 0 1 string e ShipToAddress 0 1 AddressType E Steet 0 1 sting e ShippingMethod 0 1 ShippingServiceCodeType El Street 0 1 sting e ProfileAddressChangeDate 0 1 dateTime E CityName 0 1 sting e PaymentDetailsltem 0 4 PaymentDetailsltemType E InsuranceTotal 0 1 di 0 1 string El ShippingDiscount 0 1 Country 0 1 dn la e InsuranceOptionOffered 0 1 string euam 0 1 sung e AllowedPaymentMethod 0 1 AllowedPaymentMethodType ve uds a e EnhancedPaymentData 0 1 isl AddressiD 0 1 sting e SellerDetails 0 1 SellerDetailsType El NoteText 0 1 string e AddressOwner 0 1 pa
169. ame xs string Optional A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages Character length and limitations 127 single byte alphanumeric characters FundingSourceDetail ns FundingSourceDetailsType S Optional Funding source preferences CustomerServiceNumb xs string er Optional Merchant Customer Service number displayed on the PayPal pages Character length and limitations 16 single byte characters GiftMessageEnable xs string Optional Enables the gift message widget on the PayPal pages It is one of the following values e 0 Do not enable gift message widget e 1 Enable gift message widget GiftReceiptEnable xs string Optional Enable gift receipt widget on the PayPal pages It is one of the following values e 0 Do not enable gift receipt widget e 1 Enable gift receipt widget GiftWrapEnable xs string Optional Enable gift wrap widget on the PayPal pages It is one of the following values e 0 Do not enable gift wrap widget e 1 Enable gift wrap widget NOTE If you pass the value 1 in this field values for the gift wrap amount and gift wrap name are not passed the gift wrap name is not displayed and the gift wrap amount displays as 0 00 GiftWrapName xs string Optional Label for the gift wrap option such as Box with ribbon Character length and limitations 25 single byte characters Gi ftWrapAmount ebl BasicAmounttype Optional Amount t
170. ameter missing 81126 Missing Parameter Amt Required parameter missing 81127 Missing Parameter L TaxAmt Required parameter missing 81128 Missing Parameter AuthorizationID Required parameter missing 81129 Missing Parameter CompleteType Required parameter missing 81130 Missing Parameter CurrencyCode Required parameter missing 81131 Missing Parameter TransactionID Required parameter missing 81132 Missing Parameter TransactionEntity Required parameter missing 81133 Missing Parameter Acct Required parameter missing 81134 Missing Parameter ExpDate Required parameter missing 81135 Missing Parameter FirstName Required parameter missing 81136 Missing Parameter LastName Required parameter missing 81137 Missing Parameter Street Required parameter missing 81138 Missing Parameter Street2 Required parameter missing 81139 Missing Parameter City Required parameter missing 81140 Missing Parameter State Required parameter missing 81141 Missing Parameter Zip Required parameter missing 81142 Missing Parameter CountryCode Required parameter missing 81143 Missing Parameter RefundType Required parameter missing 81144 Missing Parameter StartDate Required parameter missing SOAP API Developer Reference August 2012 289 290 API Error Codes Validation Errors Error Code Short Message Long Message 81145 Missing Parameter EndDate Required parameter missing 81146 Missing Parameter MPID Required parameter miss
171. an order The value of ParentTransactionIDis the original OrderID e Authorization of an order The value of ParentTransactionlD is the original OrderID e Capture of an order authorization e Void of an order The value of ParentTransactionID is the original OrderID Character length and limitations 16 digits ReceiptID xs string Receipt identification number Character length and limitations 16 digits in xxxx xxxx xxxx xxxx format TransactionType ns PaymentTransactionCodeType The type of transaction It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters PaymentType ebl PaymentCodeType Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters PaymentDate xs dateTime Time date stamp of payment Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z GrossAmount ebl BasicAmountType The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 269
172. an the sum of the amounts for each item in the cart Scenario When the regular non trial billing period is different than the sum of the tax for each item in the cart SOAP API Developer Reference August 2012 349 350 API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10004 Transaction refused Invalid payment type argument because of an invalid argument See additional error messages for details 10009 Transaction refused The account for the counterparty is Merchant is locked or inactive locked close restricted 10010 Invalid Invoice Non ASCII invoice id is not Non ASCII characters are used supported in InvoiceID field 10201 Agreement canceled Billing Agreement was cancelled Billing agreement is not active 10202 Exceed max Transaction would exceed user s Transaction would exceed the monthly maximum monthly limit 10203 Action required Transaction failed action required by user 10204 User s account is closed or User s account is closed or restricted restricted 10205 Risk Transaction refused due to risk model 10206 Duplicate Transaction was already processed 10207 Retry Transaction failed but user has Retry the transaction with an alternate funding source alternate funding source 10209 Disabled Preapproved Payments not Merchants is not enabled for enabled preapproved payments PAP applies only to legacy PAP billing agreements 102
173. and limitations 50 single byte characters This field is available since version 82 0 DoCapture Response Message NOTE If you use version 56 0 or later of the DoCaptue API only the authorization ID transaction ID transaction type payment date gross amount and payment status are guaranteed to be returned If you need the values of other fields and they are not returned you can obtain their values later by calling GetTransactionDetails or by using the reporting mechanism Not applicable to point of sale transactions AbstractResponseType e Timestamp 0 1 dateTime e Ack AckCodeType e CorrelationID 0 1 string gt DoCaptureResponseDetailsType AuthorizationID string e Paymentinfo PaymentinfoType el MsgSubID 0 1 string e Errors 0 ErrorType e Version string Build string 7E any e DoCaptureResponseType ves 1e DoCaptureResponseDetails 1 1 DoCaptureResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation 34 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoCapture API Operation E DoCaptureResponseDetails Type Paymentlnfo Type l AuthorizationID string TransactionID string af EbayTransactionID string ParentTransactionID Transactionld ReceiptlD string e Paymentinfo Paymentinto Type TransactionType PaymentTransactionCode Type PaymentTy
174. annot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs integer Optional Item weight corresponds to the weight of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer xs integer Optional Item length corresponds to the length of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer xs integer Optional Item width corresponds to the width of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description ItemHeight xs integer Optional Item height corresponds to the height of the item You can pass this data to the shipping carrier as is without having to make an additional database query Character length and limitations Any positive integer EbayItemPayment eBl ebayItemPaymentDetailsItemType DetailsItem Optional Information relating to an auction sale on eBay ItemURL xs string Optional
175. ansaction refused Shipping total is invalid because of an invalid argument See additional error messages for details SOAP API Developer Reference August 2012 321 322 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10428 Transaction refused Handling total is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total is invalid because of an invalid argument See additional error messages for details 10431 Item amount is invalid Item amount is invalid 10432 Transaction refused Invoice ID value exceeds because of an invalid maximum allowable length argument See additional error messages for details 10433 Transaction refused Value of OrderDescription because of an invalid element has been truncated argument See additional error messages for details 10434 Transaction refused Value of Custom element has because of an invalid been truncated argument See additional error messages for details 10435 Transaction refused The customer has not yet because of an invalid confirmed payment for this argument See additional Express Checkout session error messages for details 10441 Transaction refused The NotifyURL element value because of an invalid exceeds maximum allowable argument See additional length error messages for details 10442 ButtonSource value The ButtonSource
176. arch why it might occur and modify your implementation of Express Checkout to ensure that you generate unique invoice identification numbers 10413 Transaction refused because The totals of the cart item amounts If you receive this error be of an invalid argument See do not match order amounts sure the total of the payment additional error messages for detail item parameters such as details ItemTotal HandlingTotal TaxTotal and so forth add up to the order total SOAP API Developer Reference August 2012 307 308 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10415 Transaction refused because of an invalid argument See additional error messages for details 10418 Transaction refused because of an invalid argument See additional error messages for details 10425 Express Checkout has been disabled for this merchant 10426 Transaction refused because of an invalid argument See additional error messages for details 10427 Transaction refused because of an invalid argument See additional error messages for details 10428 Transaction refused because of an invalid argument See additional error messages for details 10429 Transaction refused because of an invalid argument See additional error messages for details 10430 Transaction refused because of an invalid argument See additional error messages for details 1
177. ashington WA West Virginia WV Wisconsin WI Wyoming WY Armed Forces Americas AA Armed Forces AE Armed Forces Pacific AP SOAP API Developer Reference August 2012 367 State and Province Codes 368 August 2012 SOAP API Developer Reference Currency Codes PayPal uses 3 character ISO 4217 codes for specifying currencies in fields and variables Currencies and Currency Codes Supported by PayPal Currency Currency Code Australian Dollar AUD Brazilian Real BRL NOTE This currency is supported as a payment currency and a currency balance for in country PayPal accounts only Canadian Dollar CAD Czech Koruna CZK Danish Krone DKK Euro EUR Hong Kong Dollar HKD Hungarian Forint HUF Israeli New Sheqel ILS Japanese Yen JPY Malaysian Ringgit MYR NOTE This currency is supported as a payment currency and a currency balance for in country PayPal accounts only Mexican Peso MXN Norwegian Krone NOK New Zealand Dollar NZD Philippine Peso PHP Polish Zloty PLN Pound Sterling GBP Singapore Dollar SGD Swedish Krona SEK Swiss Franc CHF Taiwan New Dollar TWD SOAP API Developer Reference August 2012 369 o D Currency Codes 370 Currency Currency Code Thai Baht THB Turkish Lira TRY NOTE This currency is supported as a payment currency and a currency balance for in country PayPal accounts only U S Dollar USD Currencies and Currency Codes Supported by Express Checkout and Direct Payment Express Che
178. ateTime Required The date when billing for this profile begins NOTE The profile may take up to 24 hours for activation Character length and limitations Must be a valid date in UTC GMT format xs string Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters SOAP API Developer Reference August 2012 193 FE Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation ScheduleDetailsType Fields Field Description Description xs string Required Description of the recurring payment NOTE You must ensure that this field matches the corresponding billing agreement description included in the SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters ActivationDetails ns ActivationDetailsType Optional Information about activating a profile such as whether there is an initial non recurring payment amount immediately due upon profile creation and how to override a pending profile PayPal suspends when the initial payment amount fails TrialPeriod ns BillingPeriodDetailsType Optional Trial period for this schedule PaymentPeriod ns BillingPeriodDetailsType Required Regular payment period for this schedule MaxFailedPayments xs int Optional Number of scheduled payments that can fail before the profile is automatically suspended An
179. ation identification number Character length and limits 19 single byte characters SOAP API Developer Reference August 2012 45 NS Authorization and Capture API Operation Reference DoReauthorization API Operation AuthorizationInfo Fields Field Description PaymentStatus ebl PaymentStatusCodeType Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has been canceled For example when you win a dispute PayPal returns the funds for the reversal to you Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from the buyer s bank account In Progress The transaction has not terminated For example an authorization may be awaiting completion Partially Refunded The payment has been partially refunded Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment Reversed payment was reversed due to a chargeback or other type of reversal PayPal removes the funds from your account balance and returns them to the buyer The Reas
180. ator must be a comma Equivalent to nine characters maximum for USD Quantity xs integer Item quantity This field is required when you pass a value for ItemCategory Character length and limitations Any positive integer SOAP API Developer Reference August 2012 383 Ev What s New in Version 66 What s New in Version 66 Changes to PaymentDetailsType in SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsType Fields Field Description ItemTotal ebl BasicAmountType Sum of cost of all items in this order For digital goods this field is required NOTE You must set the currencyTD attribute to one of the three character currency codes for any of the supported PayPal currencies PaymentAction ebl PaymentAct ionCodeType How you want to obtain payment When implementing digital goods this field 1s required and you must set it to Sale Changes to PaymentDetailsltemTypein SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsltemType Fields Field Description ItemCategory Name Description ns ItemCategoryType New field Indicates whether the item is digital or physical goods This field is available since version 65 1 For digital goods this field is required and you must set it to Digital It is one of the following values e Digital e Physical xs string Item name For digital goods this field is required Character length and limitations 127 single
181. available for use Use only the fields described in the documentation DoNonReferencedCreditRequestDetailsType f BasicAmountType 8 currencyID CurrencyCodeType te CreditCardDetailsType e CreditCardType ul CreditCardTypeType e CreditCardNumber 1 string e ExpMonth ul int e ExpYear 1 int e CardOwner ul PayerInfoType e Cvv2 1 string e StartMonth 1 int e StartYear ul int e IssueNumber 0 1 string Amount BasicAmountType e NetAmount 0 1 BasicAmountType TaxAmount 0 1 BasicAmountType Shipping mount 0 1 BasicAmountType e CreditCard CreditCardDetailsType ReceiverEmail 0 1 string Comment 0 1 string e ThreeDSecureRequest 0 1 ThreeDSecureRequestType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 71 72 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message e CreditCardType 0 e CreditCardNumber 0 ExpMonth 0 e ExpYear 0 e CardOwner 0 Eco 0 StartMonth 0 e StartYear 0 IssueNumber 0 e ThreeDSecureRequest 0 E CreditCardDetailsType CreditCardTypeType string int int PayerInfoType string int int string ThreeDSecureRequestType E CreditCardTypeType E PayerInfoType e Payer 0 PayerID 0 e Paye
182. ay server unavailable Unable to create payment The amount is not a valid number The amount exceeds the max limit of a single mass pay item l The amount is less than or equal to zero The unique id string length exceeds the maximum limit of 30 characters The unique id string contains a space as a character The transaction id is not valid You do not have permissions to make this API call The user is not allowed to send money through Mass Pay Account is restricted The user account has unconfirmed email The user account needs to have its sending limit removed in order to make a mass payment The user s international account needs to have its sending limit removed in order to make a mass payment The user account is receive only and therefore cannot send payments out There is some configuration error The mass pay server is unavailable Unable to create payments for masspay SOAP API Developer Reference August 2012 337 338 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10311 Unable to submit payment Unable to submit payments for masspay 10312 Masspay server error The masspay server has reported errors 10313 Masspay Invalid Data The masspay input file includes invalid data 10314 Masspay input parse error The input to the masspay server is incorrect Please make sure that you are using a correctly formatted input 10317 Masspay Invalid Email The masspay input file
183. ayment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if PaymentStatus is Pending ReasonCode ebl ReasonCodeType The reason for a reversal if the transaction type is reversal It is one of the following values e none No reason code e chargeback A reversal has occurred on this transaction due to a chargeback by your buyer e guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee e buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer e refund reversal has occurred on this transaction because you have given the buyer a refund e other A reversal has occurred on this transaction due to a reason not listed above SOAP API Developer Reference August 2012 177 178 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description ProtectionEligibili ty ProtectionEligibili tyType Storeld TerminalId xs string Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Pa
184. aymentStatus response field 42 46 147 176 271 SOAP API Developer Reference PaymentTransactionDetails response field 168 PaymentTransactionDetails response fields 170 PaymentType request field 104 237 PaymentType response field 145 174 269 PayPalAccountID request field 101 PayPalAccountID response field 125 152 PayPalAdjustment response field 115 PayPalToken response field 29 PendingFilters response field 68 152 273 PendingReason request field 280 PendingReason response field 43 47 148 177 272 Period response field 181 Peso 369 Philippine Peso 369 Phone request field 61 66 77 95 131 198 201 228 231 258 Phone response field 118 173 216 PHP 369 PLN 369 370 Polish Zloty 369 370 PostalCode re sponse field 118 PostalCode request field 61 65 77 95 130 198 201 228 231 258 PostalCode response field 173 212 216 244 251 Pound Sterling 369 370 previous versions 375 ProfileID request field 204 217 219 225 284 ProfileID response field 203 209 218 220 232 ProfileReference request field 193 225 ProfileReference response field 211 ProfileStatus response field 203 209 ProtectionEligibility response field 43 47 149 178 273 ProtectionEligibilityType response field 44 48 150 178 273 Q Quantity request field 64 100 136 202 262 382 383 385 Quantity response field 123 179 R ReasonCode response field 149 177 272 reattempt response field 181 ReceiptID requ
185. backTimeout e CallbackYersion customerserviceNumber GittMessageEnable e ciftReceip Enable G uwrapE ible e GftwrapName E cifewrapAmount e BuyerEmaiGptInEnable e SurveyEnable el SurvevOuestion o o 0 o U 10 o 0 n o o 0 o 0 o 0 o 0 o 0 o o o n o 0 o 0 o o 0 o LO o LO o o 0 0 o 0 o 0 0 0 o u 10 fo o o 0 o ro fo 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 pil 1 10 M 1 1 1 1 11 1 1 1 1 1 11 BasicAmountType string string string string string string Exp essCheckoutTokenType BaskAmountType string string string string string AddrossT pc string string string string string string string string string string ArdrressTyne PaynentActionCode ype Sol tionTypeType LandingPegeType Emeil ddr ss ype ChannelType Bili y yr eene iL DeL ail Ty pue string string ProductCategoryType ShippingServiceCodeTyse dJaleTine string FundingSourcaDetailsType string string OtharPaymentMethodDetailsType Buy2rDetailsType PaynentCetalsType ShigpingOptionType string string string string string slig string Basic AmountType string string string August 2012 amp
186. because processed Please enter a valid the CVV entered does not match the Credit Card Verification Number credit card 15005 Processor Decline This transaction cannot be The transaction was declined by the processed issuing bank not PayPal The merchant should attempt another card 15006 Processor Decline This transaction cannot be The transaction was declined by the processed Please enter a valid issuing bank not PayPal The merchant credit card number and type should attempt another card 15007 Processor Decline This transaction cannot be The transaction was declined by the processed Please use a valid issuing bank because of an expired credit card credit card The merchant should attempt another card 15008 Invalid Data This transaction has been completed but the total of items in the cart did not match the total of all items 15011 Gateway Decline This credit card was issued from an unsupported country 302 August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10001 10001 10003 10003 10003 10003 10004 10004 10004 10004 10004 10004 ButtonSource value truncated Internal Error Missing argument Missing argument Missing argument Missing argument Transaction refused because of an invalid arg
187. but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if PaymentStatus is Pending ProtectionEligibility xs string Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy SOAP API Developer Reference August 2012 47 NS Authorization and Capture API Operation Reference DoVoid API Operation Field Description ProtectionEligibility xs string Type Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNot
188. ccept or deny each of these payments To change your preference go to the Preferences section of your Profile e authorization The payment is pending because it has been authorized but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview e multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment e order The payment is pending because it is part of an order that has been authorized but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal customer service NOTE PendingReason is returned in the response only if PaymentStatus is Pending 148 August 2012 SOAP API Developer Reference ExpressC
189. ce August 2012 189 190 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation e PayerName e PayerCountry 0 e PayerBusiness 0 e Address 0 e ContactPhone 0 E PayerInfoType Payer 0 PayerID 0 PayerStatus 0 Email amp ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string AddressType string El EmailAddressType 8 UserIDType El PayPalUserStatusCodeType E PersonNameType e Salutation 0 e FirstName 0 SalutationType NameType e MiddleName 0 e LastName 0 e Suffix 0 E CountryCodeType NameType NameType SuffixType E AddressType e Mame 0 1 string e Streeti 0 1 string Street2 0 1 string CityName 0 1 string StateOrProvince 0 1 string Hl Country 0 1 CountryCodeType JE CountryName 0 1 string Phone 0 1 string PostalCode 0 1 string e AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType e External ddressID 0 1 string InternationalName 0 1 string e InternationalStateAndCity 0 1 string InternationalStreet 0 1 string e AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP AP
190. cess this info issued for a merchant account other than yours 10410 Invalid token Invalid token 10411 This Express Checkout This Express Checkout session session has expired has expired Token value is no longer valid 10412 Duplicate invoice Payment has already been made for this InvoiceID 10413 Transaction refused The totals of the cart item If you receive this error be sure the because of an invalid amounts do not match order total of the payment detail item argument See additional amounts parameters such as Item Total error messages for details Handling Total Tax Total and so forth add up to the order total 10414 Transaction refused The amount exceeds the because of an invalid maximum amount for a single argument See additional transaction error messages for details 10415 Transaction refused A successful transaction has because of an invalid argument See additional error messages for details already been completed for this token August 2012 SOAP API Developer Reference DoExpressCheckoutPayment API Errors API Error Codes Error Code Short Message Long Message Correcting This Error 10416 Transaction refused You have exceeded the because of an invalid maximum number of payment argument See additional attempts for this token error messages for details 10417 Transaction cannot The transaction cannot Instruct the buyer that PayPal is unable complete complete successfully Instruct to
191. ch representing one payment you are hosting on your marketplace Field Description OrderTotal ebl BasicAmountType Required The total cost of the transaction to the buyer If shipping cost not applicable to digital goods and tax charges are known include them in this value If not this value should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to O 1f the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to 0 purchase specific fields are ignored For digital goods the following must be true e total cost gt 0 e total cost lt total cost passed in the call to SetExpressCheckout NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ItemTotal ebl BasicAmountType Sum of cost of all items in this order For digital goods this field is required PayPal recommends that you pass the same value in the call to DoExpressCheckout Payment that you pas
192. chant Character length and limitations 1 single byte numeric character This field is available since version 53 0 ebl PaymentDetailsType Required Information about the payment August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN SetExpressCheckout API Operation Field Description AddressOverride xs string Optional Determines whether or not the PayPal pages should display the shipping address set by you in this SetExpressCheckout request not the shipping address on file with PayPal for this buyer Displaying the PayPal street address on file does not allow the buyer to edit that address It is one of the following values e 0 The PayPal pages should not display the shipping address e 1 The PayPal pages should display the shipping address Character length and limitations 1 single byte numeric character SOAP API Developer Reference August 2012 89 90 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LocaleCode PageStyle xs string Optional Locale of pages displayed by PayPal during Express Checkout It is one of the following country code values supported by PayPal default is US e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU
193. ckP eoentPositivezacot 73 1 Int le A etel rn Frilla kr nnl lunga ie n 7 40 inl InstrumenzDetais ve el instvumertuazecory Ual sra D OC Tel ad Type El of ercale 0 1 sig cl IM Sfferinfo 70 1 2 SfferlnfoTspe NOTE Not all fields shown are available for use Use only the fields described in the documentation E 3MI OtFerTnFATy Te e OfferTrackingI gt 0 rirg e Offercode 0 1 string 8 EMLOFfc Infc 0 1 BMLOFecrrfoTypz NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 111 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Zmail ddreseType li ayerIrFo7vpe X LastNare 3 1 Maner pe 8 Suffix 2 1 SUFixTvpe SamtryCodoTy gt gt Payer I 1 Email ccrezsType Payerto 3 1 User D vye E ker iyne le Payer5 abus 3 1 FayPalUser3iabelodafvpe e Payer arre Fersonam T ype le PaycrZounzry 2 1 Court yCodeType e Payers Rass 1 1 string plis le Address D 1 ddrassypo Saltator 3 1 SelutetionTyos cantar Phane 1 ring E Fistan 3 1 NareType le TaxId2ctais D 1 ToxIdD gt aibT pc s Mcdeane 3 1 NaneType e Enharcertayartr n 1 1 FrFanesdPavervaTyne E AccrassType E nama 1 1 sring E Strset1 2 1 sting 2 straetz J 1 stang CkzName 3 1 sting E dteteueP
194. ckout Currency Cur rency Code Direct Payment Currency for Specified Card in United States Direct Payment Currency for Specified Card in United Kingdom Direct Payment Currency for Specified Card in Canada Australian Dollar Canadian Dollar Czech Koruna Danish Krone Euro Hong Kong Dollar Hungarian Forint Japanese Yen Norwegian Krone New Zealand Dollar Polish Zloty Pound Sterling Singapore Dollar Swedish Krona Swiss Franc U S Dollar AUD CZK DKK EUR HKD JPY NOK NZD PLN GBP SGD SEK CHF USD Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Discover American Express Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Maestro Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard August 2012 SOAP API Developer Reference AVS and CVV2 Response Codes AVS Response Co
195. cntionoffered 0 1 strirg Allowed PaymentMeFhnd N 1 AllmvedPaymenMethudTyre nharcedPaymertData 0 1 SellerDetails 0 1 SellerDeteilsType NoteText 0 1 strirg Transactiontd 0 1 strirg JaymentAction 0 11 Payment ctionCodeType PaymentRequest D 0 1 strirg Order JRL 0 1 strirg oftDescriptor u 1 stnrg 3ranchLeve 0 1 integer OfferDetails ud S 8 9 9 9 7 8 9 S amp j 5 S 8 9 s S 8 9 5 9 9 S 9 S S 5 OfferDetailsType E ShippingdptionType shippngoptionisbefaul U 1 string ShinpingOntinn mnint 0 1 FasicAmnuntTyne e shippingOptionName 0 1 string E TotalType E IncentiveInfoType IncentiveCcde 70 1 string e pply ndicaiion 70 IncentiveapplyIndicationType xternalR ememberVeQp InDetailsType E IR berVenp InDetailsT e xternalRenemberMeOptIn 0 1 string e zxternalRenemberMeOwnerDetails 0 1 ExternalRememberveOwnerDetailsType E Howcontrolbetalls ype E zrrorunL 0 1 strirg e tnCorkextReturnURL 0 1 strirg E DisplayContrdDetaisType E InContextPaymentButtonImage 0 1 string 83 ExpressCheckout API Operations SetExpressCheckout API Operation NOTE Not all fields shown are available for use Use only the fields described in the documentation E TaxIdDetailsType e TaxIdType 0 1 string e TaxId 0 1 string e BuyerId e BuyerUs
196. countries and regions that are supported in fields and variables Countries marked with an asterisk are not supported for PayPal Payments Pro and Virtual Terminal Country or Region Country or Region Code LAND ISLANDS AX ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGUILLA AI ANTARCTICA AQ ANTIGUA AND BARBUDA AG ARGENTINA AR ARMENIA AM ARUBA AW AUSTRALIA AU AUSTRIA AT AZERBAIJAN AZ BAHAMAS BS BAHRAIN BH BANGLADESH BD BARBADOS BB BELGIUM BE BELIZE BZ BENIN BJ BERMUDA BM BHUTAN BT BOSNIA HERZEGOVINA BA SOAP API Developer Reference August 2012 357 UE Countries and Regions Supported by PayPal 358 Country or Region Country or Region Code BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI DARUSSALAM BULGARIA BURKINA FASO CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHILE CHINA CHRISTMAS ISLAND COCOS KEELING ISLANDS COLOMBIA COOK ISLANDS COSTA RICA CYPRUS CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC ECUADOR EGYPT EL SALVADOR ESTONIA FALKLAND ISLANDS MALVINAS FAROE ISLANDS FIJI BW BV BR IO BN BG s 2 a CF CL cx CC CO CK CR CY CZ DK DJ DM DO EC EG SV EE FK FO FJ August 2012 SOAP API Developer Reference Countries and Regions Supported by PayPal m Country or Region Country or Region Code FINLAND FI FRANCE FR FRENCH GU
197. cribed in the documentation ManagePendingTransactionStatus Response Fields Field Description TransactionID The transaction ID of the transaction whose payment has been denied or accepted Status Displays in the following message The Status of the transaction after running your action accept deny is TransactionStatus TransactionStatus is one of the following values e Pending Processing Completed Denied Reversed Display Only Partially Refunded Created Refunded 184 August 2012 SOAP API Developer Reference MassPay API Operation The MassPay API operation makes a payment to one or more PayPal account holders MassPay Request Message te AbstractRequestType ReceiverInfoCodeType DetailLewel 0 DetaillevelCodeType e ErrorLanguage 0 1 string e Version string FE any 0 1 MassPayRequestType e EmailSubject 0 1 string e ReceiverType 0 1 ReceiverInfoCodeType e ButtonSource 0 1 string e MassPayItem 1 250 NOTE Not all fields shown are available for use Use only the fields described in the documentation MassPay Request Fields Field Description EmailSubject xs string Optional The subject line of the email that PayPal sends when the transaction completes The subject line is the same for all recipients Character length and limitations 255 single byte alphanumeric characters SOAP API Developer Reference August 2012 185
198. cription BillingType ns BillingCodeType Required Type of billing agreement For recurring payments this field must be set to RecurringPayments In this case you can specify up to ten billing agreements Other defined values are not valid Type of billing agreement for reference transactions You must have permission from PayPal to use this field This field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e MerchantInitiatedBillingSingleAgreement PayPal creates a single billing agreement for all transactions associated with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option SOAP API Developer Reference August 2012 103 104 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BillingAgreement xs string Description Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer is billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters PaymentType ns MerchantPullPaymentCodeType Opt
199. criptionInfoType E SubscriptionTermsType reattempt string period string recurring string ses e Amount BasicAmountType amp SubscriptionID string e SubscriptionDate 0 1 dateTime e EffectiveDate 0 1 dateTime RetryTime 0 1 dateTime Username 0 1 string e Password 0 1 string Recurrences ia string e Terms 0 SubscriptionTermsType NOTE Not all fields shown are available for use Use only the fields described in the documentation ThreeDSecureInfoType E ThreeDSecureRequestType e ThreeDSecureRequest 0 1 ThreeDSecureRequestType e Eci3ds ul string e ThreeDSecureResponse 0 1 ThreeDSecureResponseType e Cavv ul string e xid 1 string e Mpivendor3ds 0 1 string e AuthStatus3ds 0 1 string E ThreeDSecureResponseType e Vpas 0 1 string e Ecisubmitted3DS 0 1 string ne NOTE Not all fields shown are available for use Use only the fields described in the documentation GetTransactionDetails Response Fields Field Description PaymentTransaction Wrapper structure Details ShippingCalculation xs string Mode Describes how the options that were presented to the buyer were determined It is one of the following values e Callback Shipping option rates are based on the buyer s location e FlatRate Shipping options are flat rates 168 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation GetTrans
200. cter length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma cc BasicAmount Type Optional The current past due or outstanding amount for this profile You can only decrease the outstanding amount It cannot be increased Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ns AutoBillType Optional This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle It is one of the following values e NoAutoBill PayPal does not automatically bill the outstanding balance e AddToNextBilling PayPal automatically bills the outstanding balance 226 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description MaxFailedPayments BillingStartdate TrialPeriod Payment Period CreditCard xs int Optional The number of failed payments allowed before the profile is automatically suspended The specified value cannot be less tha
201. ctionResponseDetailsType Field Description PaymentAdviceCode xs string Response code from the processor when a recurring transaction is declined For details on the meanings of the codes see https merchant paypal com us cgi bin amp cmd render content amp content ID merchant cc compliance error codes This field is available since version 84 0 376 August 2012 SOAP API Developer Reference What s New in Version 82 0 EE New Field in DoDirectPaymentResponse Field Description PaymentAdviceCode xs string Response code from the processor when a recurring transaction is declined For details on the meanings of the codes see https merchant paypal com us cgi bin amp cmd _render content amp content_ID merchant cc_compliance_error_codes This field is available since version 84 0 What s New in Version 82 0 New Field in DoCapture Request Field Description MerchantStoreDetails ns MerchantStoreDetailsType Optional Information about the merchant store This field is available since version 82 0 New MerchantStoreDetailsType in DoCapture Request Field Description StoreID xs string ID of the merchant store This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 84 0 TerminalID xs string Optional ID of the terminal Character length and limitations 50 single byte characters Th
202. d Management Filters Transaction blocked by your settings in FMF Could not process your request to accept deny the transaction Transaction refused Invalid Data Gateway Decline Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Reference transaction feature not currently available try again later Reference transaction feature not currently available try again later Warning Could not send email to the buyer The shipping address must match the user s address in the PayPal account Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept deny the transaction Transaction violates PayPal Use Item Category value is invalid Only Digital or Physical are allowed This transaction cannot be processed Reference transaction is not associated with a billing agreement Reference id either not found or could not be decrypted Reference id either not found or could not be decrypted This merchant is not enabled for Mark reference transaction Feature wired off Feature not supported in standin Failed to send email to buyer This error is not fatal and generates a warning The shipping address on file does not match the requested shipping address
203. d Reference Transactions API Operations SetCustomerBillingAgreement API Operation SetCustomerBillingAgreement API Operation The SetCustomerBillingAgreement API operation initiates the creation of a billing agreement NOTE If you are using Express Checkout with version 54 0 or later of the API do not use the SetCustomerBillingAgreement API operation to set up a billing agreement Use the SetExpressCheckout API operation instead SetCustomerBillingAgreement Request Message te AbstractRequestType fe SetCustomerBillingAgreementRequestDetailsType e Detaillevel 0 DetaillevelCodeType Billing greementDetails 1 1 Biling greementDetailsType e ErrorLanguage 0 1 string e ReturnURL 1 1 string el Version string e CancelURL A string 4 any 0 1 LocaleCode A string el PageStyle A string 1 cpp header image string e cpp header border color string 3 SetCustomerBillingAgreementRequestType cpp header back color 1 string amp setCustomerBilingAgreementRequestDetails SetCustomerBillingAgreementRequestDetailsType cpp payflow color 1 string BuyerEmail 1 Email ddressType e jejejejejsjojoe t RegBillingAddress A string NOTE Not all fields shown are available for use Use only the fields described in the documentation BillingAgreementDetailsType E SetCustomerBilling greementRequestDetailsType Billin
204. d ShippingMethod parameter Invalid Insurance Amount Invalid Shipping Discount The value of Description parameter has been truncated Invalid callback URL Callback URL is wrong type you must use the HTTPS Ensure that your callback URL starts with https Invalid value for AllowNote Item sales tax is invalid You must specify callback options when you specify a callback URL SOAP API Developer Reference August 2012 313 314 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error Invalid callback timeout The callback timeout is is zero you must specify a longer timeout Line items missing Line items are required when specify a callback URL for flate rate shipping options Callback URL is too long The callback URL must not exceed 1 024 characters Multiple default shipping You can only specify one default options specified shipping option at a time No default shipping option You must specify a default shipping specified option Invalid shipping total Invalid shipping total it should equal the shipping amount of the default shipping option Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option 11821 Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option type 11822 Multiple default shipping More than one shipping option type options s
205. d because Invalid eBay buyer feedback overall of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback total of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback total of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback recent of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback recent of an invalid argument See negative count additional error messages for details 10004 Transaction refused because SellerRegistrationDate is invalid of an invalid argument See additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback overall of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback overall of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback total of an invalid argument See additional error messages for details positive count August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors Error Code Short
206. d in the documentation GetBalance Request Fields Field Description ReturnAllCurrencies xs string Optional Indicates whether to return all currencies It is one of the following values e 0 Return only the balance for the primary currency holding e 1 Return the balance for each currency holding NOTE This field is availalble since version 51 Prior versions return only the balance for the primary currency holding SOAP API Developer Reference August 2012 155 GetBalance API Operation GetBalance Response Message GetBalance Response Message te AbstractResponseType fe BasicAmountType e Timestamp 0 1 dateTime a currencyID CurrencyCodeType gt Ack AckCodeType gt CorrelationID 0 1 string gt Errors 0 ErrorType el Version string gt Build string fe any GetBalanceResponseType e Balance BasicAmountT ype ces e BalanceTimeStamp dateTime e BalanceHoldings 0 BasicAmountType NOTE Not all fields shown are available for use Use only the fields described in the documentation GetBalance Response Fields Field Description Balance ebl BasicAmountType Available balance and associated currency code for the primary currency holding BalanceTimeStamp xs dateTime Time that the balance was reported BalanceHoldings ebl BasicAmountType Available balance and associated currency code for each currency held including the primary currency The first currency is th
207. d on a secure https server If you do not specify an image the business name displays Character length and limitations 127 single byte alphanumeric characters cpp header border xs string color Optional Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high By default the color is black Character length and limitations 6 character HTML hexadecimal ASCII color code cpp header back xs string color Optional Sets the background color for the header of the payment page By default the color is white Character length and limitations 6 character HTML hexadecimal ASCII color code cpp payflow color xs string Optional Sets the background color for the payment page By default the color is white Character length and limitations 6 character HTML hexadecimal ASCII color code PaymentAction ebl PaymentAct ionCodeType deprecated Optional How you want to obtain payment If the transaction does not include a one time purchase this field is ignored It is one of the following values e Sale This is a final sale for which you are requesting payment default e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to
208. d to the buyer The reason for the reversal is specified in the ReasonCode element e Processed A payment has been accepted e Voided An authorization for this transaction has been voided SOAP API Developer Reference August 2012 271 272 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PendingReason ReasonCode ebl PendingStatusCodeType The reason the payment is pending It is one of the following values none No pending reason address The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile authorization The payment is pending because it has been authorized but not settled You must capture the funds first echeck The payment is pending because it was made by an eCheck that has not yet cleared int1 The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment order The payme
209. d value 13601 Refund cannot exceed the Refunds to users without PayPal transaction amount accounts cannot exceed the transaction amount 13602 Insufficient funds Refund failed due to insufficient funds in your PayPal account SOAP API Developer Reference August 2012 335 API Error Codes MassPay API Errors MassPay API Errors MassPay API Errors Error Code Short Message Long Message 10001 10001 10001 10001 10001 10002 10004 10004 10004 10004 10004 10004 Invalid account number Internal Error Internal Error ButtonSource value truncated Transaction refused because of an invalid argument See additional error messages for details Account locked Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details The transaction failed as a result of an invalid credit card number Check the number or attempt with another card Internal Error The tra
210. dNumber 0 1 string e ExpMonth 0 1 int e ExpYear 0 1 int e CardOwner 0 1 PayerlnfoType e Cv V2 0 1 string e StartMonth 0 1 int e StartYear 0 1 int e IssueNumber 0 1 string e ThreeDSecureRequest 0 1 ThreeDSecureRequestType NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference le PaymentDetails Type e OrderTotal e ltemTotal Shipping Tata Handling Total TaxTntal le OrderDescripicn Custom Invo celD le ej e 8 8 Lol Buttons urce NotityURL 8 ShipToAcdress e ShippingMethod Profile AddressChanqeDate PaymentDetailsltern Insurance Tulal E ShippingDiscount Insurance IptionOftered e AllowedPaymentMethod e EntancecPaymentDaia SellerDelails e NoteText el Trarsactionld 8 PaymentAction Le 2 PoymentRequestlC e OrderURL e SoftDescripto e BrarchLovol e OffoDc ails e Recurring 4 1 1 1 1 1 1 1 M 1 1 1 fo n 0 4 SOAP API Developer Reference 1 d ET 1 1 1 1 1 1 d 1 1 1 1 L1 string string string string string AddressType ShippingServiceCodeType dateTime PaymentDeteilsltem ype string AllowedPaymentMatiodType SellarDelailsType string string Payment ctionZoceType string string string integer DfferDetaloType RecurrngFlag Ty
211. ddress is not currently supported to allow Direct currently supported Payment transactions 10761 Gateway Decline This transaction cannot be The transaction was declined because processed Please check the PayPal is currently processing a status of your first transaction transaction by the same buyer for the before placing another order same amount Can occur when a buyer submits multiple identical transactions in quick succession 10762 Gateway Decline This transaction cannot be The CVV provide is invalid The CVV is processed between 3 4 digits long 10763 Invalid Data This transaction cannot be None this is a PayPal internal error processed 10764 Thistransactioncannotbe This transaction cannot be The transaction was declined by PayPal processed at this time processed at this time Please try Please try again later If the problem Please try again later again later persists please contact PayPal 11068 Seller restriction All sellers restricted 11610 Payment Pending your Payment Pending your review in review in Fraud Fraud Management Filters Management Filters 11611 Transaction blocked by Transaction blocked by your your settings in FMF settings in FMF 11612 Could not process your Could not process your request to request to accept deny the accept deny the transaction transaction 11821 This transaction cannot be This transaction cannot be You cannot capture a payment after it processed processed because it has already has been
212. denied by a Fraud Management been denied by a Fraud Filter You can control whether a Fraud Management Filter Management Filter denies a transaction by changing the filter s settings in the profile 12000 Transaction is not Transaction is not compliant due Check ECI ECI3DS CAVV XID fields compliant due to missing or invalid 3 D Secure authentication values SOAP API Developer Reference to missing or invalid 3 D Secure authentication values August 2012 301 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 12001 Transaction is not Transaction is not compliant due Check ECI ECI3DS CAVV XID fields compliant due to missing to missing or invalid 3 D Secure or invalid 3 D Secure authentication values authentication values 15001 Gateway Decline This transaction cannot be The transaction was rejected by PayPal processed because of excessive failures over a short period of time for this credit card Contact PayPal for more information 15002 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 15003 Invalid Configuration This transaction cannot be The transaction was declined because processed the merchant does not have a valid commercial entity agreement on file with PayPal Contact PayPal for more information 15004 Gateway Decline This transaction cannot be The transaction was declined
213. des Related information DoDirectPayment Response Fields AVS Response Codes for Visa MasterCard Discover and American Express AVS Code Meaning Matched Details A Address Address only no ZIP code B International A Address only no ZIP code C International N None NOTE The transaction is declined D International X Address and Postal Code E Not allowed for MOTO Not applicable Internet Phone transactions NOTE The transaction is declined F UK specific X Address and Postal Code G Global Unavailable Not applicable I International Unavailable Not applicable Address Address and Postal Code No None NOTE The transaction is declined P Postal International Z Postal Code only no Address R Retry Not applicable S Service not Supported Not applicable U Unavailable Not applicable Whole ZIP Nine digit ZIP code no Address SOAP API Developer Reference August 2012 371 AVS and CVV2 Response Codes AVS Response Codes AVS Code Meaning Matched Details X Exact match Address and nine digit ZIP code Y Yes Address and five digit ZIP Z ZIP Five digit ZIP code no Address All others Error Not applicable Related information DoDirectPayment Response Fields AVS Response Codes for Maestro AVS Code Meaning Matched Details 0 All the address information matched All information matched 1 None of the address information None matched NOTE The transaction is declined 2 Part of
214. description of individual APIs Related information SOAP RequesterCredentials Username Password Signature and Subject 20 August 2012 SOAP API Developer Reference PayPal SOAP API Basics FEN SOAP Message Style doc literal SOAP Message Style doc literal PayPal uses doc literal SOAP messaging not rpc encoding With doc literal a single service interface call passes an XML document in the request to the PayPal API server which responds with an XML document instance Response Structure The following is an annotated description of the structure of a SOAP response from the PayPal API where response is Success lt xml version 1 0 gt lt SOAP ENV Envelope xmlns SOAP ENV http schemas xmlsoap org soap envelope xmlns SOAP ENC http schemas xmlsoap org soap encoding xmlns xsi http ww w3 org 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema xmlns xs http ww w3 org 2001 XMLSchema xmlns cc urn ebay apis CoreComponentTypes xmlns wsu http schemas xmlsoap org ws 2002 07 utility xmlns saml urn oasis names tc SAML 1 0 assertion xmlns ds http www w3 0rg 2000 09 xmldsigt xmlns wsse http schemas xmlsoap org ws 2002 12 secext xmlns ebl urn ebay apis eBLBaseComponents xmlns ns urn ebay api PayPalAPI lt SOAP ENV Header gt lt Security xmlns http schemas xmlsoap org ws 2002 12 secext xsi type wsse SecurityType gt RequesterCredentials
215. dressID 1 string e AddressOwner ul AddressOwnerCodeType e ExternalAddressID 41 string InternationalName T string InternationalStateAndCity 0 1 string InternationalStreet 1 string AddressStatus ul AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 165 nm GetTransactionDetails API Operation GetTransactionDetails Response Message PaymentInfoType E TransactionId E Trensactionta amp TransactionID string l EbayTransactionID string e ParentTransactionID 0 1 TransactionId JE ReceiptID 0 1 string TransactionType PaymentTransactionCodeType e PaymentType 0 1 PaymentCodeType E PaymentDate dicens 8 currencyID CurrencyCodeType e GrossAmount BasicAmountType e FeeAmount 0 1 BasicAmountType Ei PaymentstatusCodeType e Settle amp mount 0 1 BasicAmountType e TaxAmount 0 1 BasicAmountType El PendingstatuscodeType e ExchangeRate 0 1 string e PaymentStatus PaymentStatusCodeType E Reversakessoncodetyre e PendingReason 0 1 PendingStatusCodeType e ReasonCode 0 1 ReversalReasonCodeType e ShippingMethod 0 1 string e ProtectionEligibility 0 1 string e ShipAmount 0 1 string e ShipHandle mount 0 1 string e ShipDiscount 0 1 string e InsuranceAmount 0
216. ds 40 DoAuthorization request message 40 DoAuthorization response fields 41 DoAuthorization response message 41 DoCapture API operation 31 DoCapture request fields 32 DoCapture request message 31 DoCapture response fields 35 DoCapture response message 34 DoDirectPayment API operation 51 DoDirectPayment request fields 56 DoDirectPayment request message 51 DoDirectPayment response fields 68 DoDirectPayment response message 67 DoExpressCheckoutPayment API operation 126 DoExpressCheckoutPayment request fields 128 DoExpressCheckoutPayment request message 126 DoExpressCheckoutPayment response fields 142 DoExpressCheckoutPayment response message 139 DoNonReferencedCredit API operation 71 DoNonReferencedCredit request fields 73 DoNonReferencedCredit request message 71 DoNonReferencedCredit response fields 78 DoNonReferencedCredit response message 78 DoReauthorization API operation 44 DoReauthorization request message 44 DoReauthorization response message 45 DoReferenceTransaction API operation 251 DoReferenceTransaction request fields 255 DoReferenceTransaction request message 251 DoReferenceTransaction response fields 267 DoReferenceTransaction response message 265 DoVoid API operation 48 SOAP API Developer Reference Do Void request fields 49 Do Void request message 48 Do Void response fields 50 DoVoid response message 49 E EbayItemPayment DetailsItem request field 100 137 EbayItemPayment DetailsItem response field 123 EbayIt
217. e e eee 220 UpdateRecurringPaymentsProfile API Operation rar rann 221 UpdateRecurringPaymentsProfile Request Message 221 UpdateRecurringPaymentsProfile Response Message 232 SetCustomerBillingAgreement API Operation 2 av rar 0 000 eee ee 233 SetCustomerBillingAgreement Request Message 233 SetCustomerBillingAgreement Response Message 2 ar vr o 237 6 August 2012 SOAP API Developer Reference Contents E CreateBillingAgreement API Operation rar rar rn rann 238 CreateBillingAgreement Request Message rann 238 CreateBillingAgreement API Response Message 239 GetBillingAgreementCustomerDetails API Operation lll 240 GetBillingAgreementCustomerDetails Request Message 240 GetBillingAgreementCustomerDetails Response Message 241 BAUpdate API Operation raner ann 245 BAUpdate Request Message 2 2 llle 245 BAUpdate Response Message llle 246 DoReferenceTransaction API Operation vr 000 eee ee eee 251 DoReferenceTransaction Request Message o 251 DoReferenceTransaction Response Message llle 265 Chapter 13 RefundTransaction API Operation 275 RefundTransaction Request Message ens 275 RefundTransaction Request Fields LL arr
218. e Field Description PaymentStatus ebl PaymentStatusCodeType Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has been canceled for example when you win a dispute and the funds for the reversal have been returned to you e Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your buyer s bank account e In Progress The transaction has not terminated for example an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returned to the buyer The reason for the reversal is specified in the ReasonCode element e Processed A payment has been accepted e Voided An authorization for this transaction has been voided 176 August 2012 SOAP API Developer Reference GetTransactionDetails
219. e Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed xs string Person s name associated with this address Character length and limitations 32 single byte characters xs string First street address Character length and limitations 100 single byte characters xs string Second street address Character length and limitations 100 single byte characters xs string Name of city Character length and limitations 40 single byte characters xs string State or province Required for U S addresses only Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters ebl CountryCode Country code Character length and limitations 2 single byte characters 244 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 BAUpdate API Operation BAUpdate API Operation The BAUpdate API operation updates or deletes a billing agreement BAUpdate Request Message te AbstractRequestType MerchantPullStatusCodeType e Detaillevel 0 DetaillevelCodeType ErrorLanguage 0 1 string Version string PE any 0 1 BAUpdateRequestType e ReferenceID string e Biling amp greementDescription 0 1 string e Biling amp greementStatus 0 1 MerchantPullStatusCodeType e Bill
220. e Country code It is required if using a shipping address Character length and limitations 2 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters ThreeDSecureRequest Fields U K Merchants Only Field Description AuthStatus3ds xs string Optional A value returned by the Cardinal Centinel If the cmpi lookup request returns Y for Enrolled set this field to the PAResStatus value returned by cmpi authenticate Otherwise set this field to blank MpiVendor3ds xs string Optional A value returned by the Cardinal Centinel Set this field to the Enrolled value returned by cmpi lookup Cavv xs string Optional A value returned by the Cardinal Centinel If the cmpi lookup request returns Y for Enrolled set this field to the Cavv value returned by cmpi authenticate Otherwise set this field to blank Eci3ds xs string Optional A value returned by the Cardinal Centinel If the cmpi lookup request returns Y for Enrolled set this field to the EciFlag value returned by cmpi authenticate Otherwise set this field to the EciFlag value returned by cmpi lookup XID xs string Optional A value returned by the Cardinal Centinel If the cmpi lookup request returns Y for Enrolled set this field to the Xid value returned by cmpi authenticate Otherwise set this field to blank 66 August 2012 SOAP API Developer Reference DoDirectPayment API Operation am
221. e Use only the fields described in the documentation AddressVerifyRequest Fields Field Description Email ebl EmailAddressType Required Email address of a PayPal member to verify Character length and limitations 255 single byte characters maximum with the input mask SOAP API Developer Reference August 2012 27 p Address Verify API Operation Address Verify Response Message Field Description Street xs string Required First line of the billing or shipping postal address to verify To pass verification the value of Street must match the first 3 single byte characters of a postal address on file for the PayPal member Character length and limitations 35 single byte characters maximum including alphanumeric plus Whitespace and case of input value are ignored Zip xs string Required Postal code to verify To pass verification the value of Zip must match the first 5 single byte characters of the postal code of the verified postal address for the verified PayPal member Character length and limitations 16 single byte characters maximum Whitespace and case of input value are ignored AddressVerify Response Message e AbstractResponseType AddressStatusCodeType Timestamp 0 1 dateTime el Ack AckCodeType MatchStatusCodeType e CorrelationID 0 1 string el Errors 0 ErrorType CountryCodeType e Version string e Build string e any AddressverifyResponseType
222. e Use only the fields described in the documentation SOAP API Developer Reference August 2012 51 DoDirectPayment API Operation DoDirectPayment Request Message E e PaymentAction e PaymentDetails PaymentDetails Type e CreditCard CreditCardDetails Type e IPAddress string e MerchantSessionld 0 1 string e ReturnFMFDetails 0 1 boolean DoDirectPaymentRequestDetails Type E PaymentActionCodeType E PaymentDetails Type 0 e OrderTotal e ItemTotal e ShippingTotal e Handling Total PaymentActionCodeType 52 e TaxTotal e OrderDescription e Custom e InvoicelD e ButtonSource E Notify URL e ShipToAddress e ShippingMethod e ProfileAddressChangeDate e PaymentDetailsltem e InsuranceTotal e ShippingDiscount e InsuranceOptionOffered e AllowedPaymentMethod e EnhancedPaymentData e SellerDetails e NoteText e Transactionld e PaymentAction e PaymentRequestlD e OrderURL e SoftDescriptor e BranchLevel E OfferDetails e Recurring string string string string string AddressType ShippingServiceCode Type dateTime PaymentDetailsltem Type string AllowedPaymentMethodType SellerDetailsType string string PaymentActionCodeType string string string integer OfferDetailsType RecurringFlagType E CreditCardDetails Type e CreditCardType 0 1 CreditCardTypeType e CreditCar
223. e regular non trial billing period is different than the sum of the tax for each item in the cart Occurs when the billing agreement is disabled or inactive The credit card used is expired The CVV provided is invalid The CVV is between 3 4 digits long The transaction was refused because the AVS response returned the value of N and the merchant account is not able to accept such transactions Your PayPal account is restricted Contact PayPal for more information The expiration date must be a two digit month and four digit year You must submit an IP address of the buyer with each API call The credit card type entered is not currently supported by PayPal SOAP API Developer Reference August 2012 339 340 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10511 Invalid Data This transaction cannot be The merchant selected an value processed for the PaymentAction field that is not supported 10512 Invalid Data This transaction cannot be The first name of the buyer is processed Please enter a first required for this merchant name 10513 Invalid Data This transaction cannot be The last name of the buyer is processed Please enter a last required for this merchant name 10535 Gateway decline This transaction cannot be processed Please enter a valid credit card number and type 10548 Invalid Configuration This transaction cannot b
224. e such as a credit card charge using the DoDirectPayment API or a billing agreement ID PaymentAction xs string Optional How you want to obtain payment It is one of the following values e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Sale Thisis a final sale for which you are requesting payment PaymentDetails ebl PaymentDetailsType Required Information about the payment SOAP API Developer Reference August 2012 255 FE Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description IPAddress xs string Optional IP address of the buyer s browser NOTE PayPal records this IP addresses as a means to detect possible fraud Character length and limitations 15 single byte characters including periods for example 255 255 255 255 ReqConfirmShipping Whether you require that the buyer s shipping address on file with PayPal be a confirmed address You must have permission from PayPal to not require a confirmed address It is one of the following values e 0 You do not require that the buyer s shipping address be a confirmed address e 1 You require that the buyer s shipping address be a confirmed address NOTE Setting this field overrides the setting you have specified in your Merchant Account Profile Character length and limitations 1 single byte numeric character MerchantSessio
225. e The merchant account processed The merchant s account attempting the transaction is not is not able to process transactions a business account at PayPal Check your account settings 10550 Invalid Configuration This transaction cannot be Access to Direct Payment was processed disabled for your account Contact PayPal for more information 10561 Invalid Data There s an error with this transaction Please enter complete billing address 10565 Merchant country The merchant country is not unsupported supported 10709 Invalid Data There s an error with this There was a problem with a transaction Please enter an particular field in the address address1 in the billing address The long error message tells you which field is invalid 10710 Invalid Data There s an error with this There was a problem with a transaction Please enter a city in particular field in the address the billing address The long error message tells you which field is invalid 10711 Invalid Data There s an error with this There was a problem with a transaction Please enter your state particular field in the address in the billing address The long error message tells you which field is invalid 10712 Invalid Data There s an error with this There was a problem with a transaction Please enter your five digit postal code in the billing address particular field in the address The long error message tells you which field is invalid August 2
226. e Update NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 221 12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation E AddressType E UpdateRecurringPaymentsProfileRequestDetailsType ProfileID 1 1 string e Name 0 1 string e Note 0 1 string Street1 0 1 string Description 0 1 string Street2 0 1 string e SubscriberName 0 1 string CityName 0 1 string e SubscriberShippingAddress 0 1 AddressType StateOrProvince 0 1 string e ProfileReference 0 1 string amp Country 0 1 CountryCodeType e AdditionalBillingCycles 0 1 int LEl CountryName 0 1 string E Amount 0 1 BasicAmountType Phone 0 1 string ses Shipping mount 0 1 BasicAmountType PostalCode 0 1 string TaxAmount 0 1 BasicAmountType e AddressID 0 1 string e OutstandingBalance 0 1 BasicAmountType e AddressOwner 0 1 AddressOwnerCodeType e AutoBillOutstanding mount 0 1 AutoBillType External ddressID 0 1 string e MaxFailedPayments 0 1 int InternationalName 0 1 string e CreditCard 0 1 CreditCardDetailsType InternationalStateAndcity 0 1 string e BilingstartDate 0 1 dateTime InternationalStreet 0 1 string e TrialPeriod 0
227. e associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters Streetl xs string First street address It is required if using a shipping address Character length and limitations 100 single byte characters Street2 xs string Optional Second street address Character length and limitations 100 single byte characters CityName xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters StateOrProvince xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters PostalCode xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address and may be required for other countries Character length and limitations 20 single byte characters Country ebl CountryCodeType Country code It is required if using a shipping address Character length and limitations 2 single byte characters August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description Phone xs string Optional Phone number Character length and limitations 20 single byte characters PaymentDetailsType Fields When implementing parallel payments you can create up to 10 sets of payment details type parameter fields ea
228. e back to an object SOAP API Developer Reference August 2012 15 PayPal SOAP API Basics PayPal WSDL XSD Schema Definitions PayPal WSDL XSD Schema Definitions The PayPal Web Services schema and its underlying eBay Business Language eBL base and core components are required for developing applications with the PayPal Web Services API The following are the locations of the WSDL and XSD files Location of PayPal WSDL and XSD Files Development and Test with the PayPal Sandbox API Service PayPal Schema https www sandbox paypal com wsdl PayPalSvc wsdl eBL Base Components and https www sandbox paypal com wsdl eBLBaseComponents xsd Component Types https www sandbox paypal com wsdl CoreComponentTypes xsd Production with Live PayPal Web Services API Service PayPal Schema https www paypal com wsdl PayPalSvc wsdl eBL Base Components and http www paypal com wsdl eBL BaseComponents xsd Component Types http www paypal com wsdl CoreComponentTypes xsd PayPal SOAP API Definitions The PayPal SOAP API comprises individual API definitions for specific business functions As a foundation the API relies on eBay Business Language eBL base and core components The core eBL structures AbstractRequestType and AbstractResponseType are the basis of the SOAP request and response of each PayPal API AbstractResponseType is also the framework for error messages common across all PayPal APIs PayPal has made some
229. e credit card funding source with which source with which to pay associated with the account to pay could not be used and there is no other funding source with which to complete the transaction 11091 The transaction was The transaction was blocked as it The transaction was declined by blocked as it would exceed would exceed the sending limit for PayPal Please have the buyer the sending limit for this this buyer contact PayPal Customer buyer Service 11302 Cannot pay self The transaction was refused Cannot pay self Merchant is because you cannot send money to referencing own transaction yourself 11451 Billing Agreement Id or Billing Agreement Id or Invalid reference id transaction Id is not valid transaction Id is not valid August 2012 SOAP API Developer Reference API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 11451 11451 11451 11452 11453 11453 11454 11459 11610 11611 11612 13122 13701 18014 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Reference transactions temporarily unavailable Reference transactions temporarily unavailable Warning Could not send email to the buyer Invalid Data Payment Pending your review in Frau
230. e field 115 169 GiftMessageEnable request field 93 GiftReceiptEnable request field 93 129 GiftReceiptEnable response field 116 169 GiftWrapAmount request field 93 129 GiftWrapAmount response field 116 170 GiftWrapEnable request field 93 GiftWrapName request field 93 129 GiftWrapName response field 116 169 giropayCancelURL request field 92 giropaySuccessURL requ est field 92 GrossAmount response field 145 174 269 286 GrossRefundAmount response field 279 H HandlingTotal request field 62 97 132 259 HandlingTotal response field 120 HKD 369 HoldDecision response field 149 Hong Kong Dollar 369 HUF 369 370 Hungarian Forint 369 370 ID response field 69 153 274 ILS 369 InitialAmount request field 197 InstrumentDetails response field 151 InsuranceOp tion Offered response field 120 InsuranceOptionOffered request field 97 132 InsuranceOptionSelected request field 138 InsuranceOptionSelected response field 124 151 169 InsuranceTotal request field 62 96 132 InsuranceTotal response field 120 InvoicelD request field 32 63 87 98 133 260 276 282 InvoicelD response field 114 178 InvoiceID responsefield 121 IPAddress request field 57 256 Israeli Sheqel 369 IssueNumber request field 59 76 200 230 264 IssueNumber response field 215 Ite mCategory 261 SOAP API Developer Reference ItemCategory 383 ItemCategory request field 101 137 202 382 ItemCategory response field 123 ItemHeight request f
231. e outstanding balance amount in the next billing cycle The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid It is one of the following values e NoAutoBill PayPal does not automatically bill the outstanding balance amount e AddToNextBilling PayPal automatically bills the outstanding balance amount xs int Number of scheduled payments that can fail before the profile is automatically suspended Character length and limitations Number string representing an integer ns RecurringPaymentsProfileDetailsType Buyer information for this recurring payments profile ns BillingPeriodDetailsType Details of the current subscription period This field is not returned if the profile is canceled or expired ns RecurringPaymentsSummaryDetailsType Payment summary for this recurring payments profile ns Amount Type Total amount collected thus far for scheduled payments Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ns Amount Type Total amount collected thus far for optional payments Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2
232. e primary currency 156 August 2012 SOAP API Developer Reference GetPalDetails API Operation The GetPalDetails API operation obtains your Pal ID which is the PayPal assigned merchant account number and other information about your account You need the account number when working with dynamic versions of PayPal buttons and logos GetPalDetails Request Message fe AbstractRequestType Detaillevel 0 DetaillevelCodeType e ErrorLanguage 0 1 string Version string PE any 0 1 GetPalDetailsRequestType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 157 m GetPalDetails API Operation GetPalDetails Response Message GetPalDetails Response Message te AbstractResponseType e Timestamp 0 1 dateTime e Ack AckCodeType e CorrelationID 0 1 string e Errors 0 ErrorType Version string e Build string P any GetPalDetailsResponseType e Pal string e Locale string NOTE Not all fields shown are available for use Use only the fields described in the documentation GetPalDetails Response Fields Field Description Pal xs string PayPal assigned merchant account number 158 August 2012 SOAP API Developer Reference GetPalDetails API Operation 8 GetPalDetails Response Message Field Description Locale xs string Country code representing the mercha
233. e request Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 41 Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 AuthorizationInfo Fields Field Description PaymentStatus ebl PaymentStatusCodeType Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has been canceled For example when you win a dispute PayPal returns the funds for the reversal to you e Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired
234. e response for a point of sale authorization the only value value is Completed e None No status e Canceled Reversal This means a reversal has been canceled For example you won a dispute with the customer and the funds for the transaction that was reversed have been returned to you e Completed The payment has been completed and the funds have been added successfully to your account balance This is the only value status for point of sale transactions e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your customer s bank account e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returned to the buyer The reason for the reversal is specified in the ReasonCode element e Processed A payment has been accepted e Voided An authorization for this transaction has been voided 38 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoCapture API Operation Field Description PendingReason ebl PendingSta
235. eType Receiver 0 1 Email ddressType E ReceiptID 0 1 string u ac TransactionID 0 1 TransactionId S eurrencyID CurrencyCodeType e ProfileID 0 1 string sos E PayerName 0 1 PersonNameType CurrencyCodeType e AuctionItemNumber 0 1 string InvoiceID 0 1 string PaymentTransactionStatusCodeType e CardNumber 0 1 string e TransactionClass 0 1 PaymentTransactionClassCodeType e Amount 0 1 BasicAmountType e CurrencyCode 0 1 CurrencyCodeType e Status 0 1 PaymentTransactionStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 281 14 TransactionSearch API Operation TransactionSearch Request Message TransactionSearch Request Fields Field Description StartDate EndDate Payer Receiver ReceiptID TransactionID InvoiceID CardNumber PayerName xs dateTime Required The earliest transaction date at which to start the search Character length and limitations No wildcards are allowed The value must be in UTC GMT xs dateTime Optional The latest transaction date to be included in the search Character length and limitations No wildcards are allowed The value must be in UTC GMT xs string ebl EmailAddressType Optional Search by the buyer s email address Character length and limitations 127 single byte a
236. eType El PayPalUserStatusCodeType e PayerCountry 0 1 CountryCodeType E PersonNameType e PayerBusiness 0 string e Address 0 1 AddressType e ContactPhone 0 1 string e Salutation 0 1 SalutationType e FirstName 0 1 NameType e MiddleName 0 1 NameType e LastName 0 1 NameType Suffix 0 1 SuffixType E CountryCodeType E AddressType Name string reel 1 string E Street1 tri e Stree 41 string e Street2 tri e CityName 1 string e StateOrProvince bi string Er Country P CountryCodeType HF CountryName 1 string e Phone 1 string e PostalCode 1 string e AddressID 41 string e AddressOwner 1 AddressOwnerCodeType e ExternalAddressID 41 string e InternationalName la string InternationalStateAndCity 0 1 string InternationalStreet 1 string e AddressStatus 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation 208 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 GetRecurringPaymentsProfileDetails API Operation AddressType E CountryCodeType e Name e Street1 e Street2 e CityName e StateOrProvince Hl Country amp CountryName Phone PostalCode e AddressID e AddressOwner e External ddressID e Internationa
237. ebl NameUser Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Buyer s suffix Character length and limitations 12 single byte characters AddressType Fields Field Description Name Streetl xs string Billing name associated with this billing address Character length and limitations 32 single byte characters xs string First billing street address Character length and limitations 100 single byte characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations KENT DoReferenceTransaction API Operation Field Description Street2 xs string Second billing street address Character length and limitations 100 single byte characters CityName xs string Name of billing city Character length and limitations 40 single byte characters StateOrProvince xs string Billing state or province Required for U S addresses only Character length and limitations 40 single byte characters PostalCode xs string U S billing ZIP code or other country specific postal code Character length and limitations 20 single byte characters Country ebl CountryCode Billing country code Character length and limitations 2 single byte characters DoReferenceTransaction API Operation The DoReferenceTransaction API
238. ecause of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Invalid item URL SellerRegistrationDate is invalid Invalid eBay seller feedback overall positive count Invalid eBay seller feedback overall negative count Invalid eBay seller feedback total positive count Invalid eBay seller feedback total negative count Invalid eBay seller feedback recent positive count Invalid eBay seller feedback recent negative count Invalid eBay item transaction date Invalid eBay item buyer protection type SOAP API Developer Reference August 2012 319 320 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused Invalid eBay item payment because of an invalid hold risk argument See additional error messages for details 10004 Transaction refused Multiple eBay order IDs not because of an invalid allowed argument See additional error messages for details 10007 Permission denied You do not have permissions to make this API call 10406 Transaction refused The PayerID value is invalid because of an invalid argument See additional error messages for details 10408 Express Checkout tokenis Express Checkout token is missing missing 10409 You re not authorized to Express Checkout token was ac
239. ects gift option on the PayPal pages Character length and limitations 25 single byte characters ebl BasicAmountType Returns the gift wrap amount only if the buyer selects the gift option on the PayPal pages NOTE You must set the currency1D attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have two decimal places decimal separator must be a period and the optional thousands separator must be a comma ebl EmailAddressType Buyer s email address if the buyer provided it on the PayPal pages Character length and limitations 127 single byte characters xs string Survey question on the PayPal checkout pages Character length and limitations 50 single byte characters xs string Survey response the buyer selects on the PayPal pages Character length and limitations 15 single byte characters ns PaymentRequest InfoType Payment request information for each bucket in the cart PayerlnfoType Fields Field Description Payer ebl EmailAddressType Email address of buyer Character length and limitations 127 single byte characters PayerID ebl UserIDType Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters August 2012 SOAP API Developer Reference ExpressCheckout API Operations mI GetExpressC
240. ed but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview e multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment e order The payment is pending because it is part of an order that has been authorized but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if PaymentStatus is Pending ProtectionEligibility xs string Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment
241. een completed DoCapture authorization DoReauthorization DoVoid 10603 The buyer is The buyer account is DoAuthorization Contact the buyer restricted restricted DoCapture DoReauthorization DoVoid SOAP API Developer Reference August 2012 327 328 API Error Codes Authorization and Capture API Errors Error Short Returned By API Correcting This Code Message Long Message Call Error 10604 Authorization Authorization transaction DoAuthorization Review the order to must include cannot be unilateral It ensure customer and both buyer and must include both buyer seller are both PayPal seller and seller to make an members auth 10605 Unsupported Currency is not DoAuthorization Retry the request with a currency supported DoCapture PayPal supported currency 10606 Buyer cannot Transaction rejected DoAuthorization Contact the buyer pay please contact the buyer DoCapture DoReauthorization 10607 Auth amp Capture Authorization amp Capture DoAuthorization Contact PayPal Customer unavailable feature unavailable DoCapture Service DoReauthorization DoVoid 10608 Funding source The funding source is DoAuthorization Contact the buyer missing missing DoCapture DoReauthorization 10609 Invalid Transaction id is invalid DoAuthorization Check the validity of the transactionID DoCapture authorization ID and DoResuthodzaton reattempt the request DoVoid 10610 Amount limit Amount specified DoAuthorization Reattempt
242. egoryType Indicates whether the item is digital or physical For digital goods ItemCategory Digital this field is required It is one of the following values e Digital e Physical This field is available since version 65 1 SOAP API Developer Reference August 2012 123 124 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation EbayltemPaymentDetailsltemType Fields Field Description ItemNumber AuctionTransactionId xs string Auction item number Character length 765 single byte characters xs string Auction transaction identification number Character length 255 single byte characters OrderID xs string Auction order identification number Character length 64 single byte characters Cart ID xs string The unique identifier provided by eBay for this order from the buyer Character length 255 single byte characters UserSelectedOptionsType Fields Field Description ShippingCalculationM xs string ode InsuranceOptionSelec ted ShippingOptionIsDefa ult ShippingOptionAmount Describes how the options that were presented to the buyer were determined It is one of the following values e APT Callback e API Flatrate xs boolean The option that the buyer chose for insurance It is one of the following values e Yes The buyer opted for insurance e No The buyer did not opt for insurance xs boolean Indicates whether the buyer chose the default shipping optio
243. eld 62 97 ShippingDiscount response field 120 ShippingOptionA mount request field 103 138 ShippingOptionA mount response field 124 151 169 ShippingOptionIsDefault request field 103 138 ShippingOptionIsDefault response field 124 151 169 ShippingOptionName request field 103 138 ShippingOptionName response field 125 151 169 ShippingOptionsType request fields 103 ShippingTotal request field 61 96 132 259 ShippingTotal response field 119 ShipToAddress request field 63 98 134 261 398 August 2012 ShipToAddress response field 121 ShortMessage response field 125 151 Singapore Dollar 369 370 SOAP API definitions 16 SOAP request envelope 18 SoftDescriptor request field 33 134 257 SolutionType request field 92 StartDate request field 282 283 StartMonth request field 58 75 199 230 263 StartMonth response field 215 StartYear request fie ld 59 76 199 230 264 StartYear response field 215 state and proivince codes 365 StateOrProvince request field 60 65 77 95 130 198 201 228 231 258 StateOrProvince respon se field 118 StateOrProvince response field 173 212 216 244 251 Status request field 284 Status response field 184 286 Storeld 150 178 273 StoreID request field 34 277 377 378 Street request field 28 Street request field 60 65 77 95 130 198 201 227 231 258 Streetl response field 118 173 211 216 244 250 Street2 request field 60 65 77 95 130 198 201 227 231
244. eld is introduced in version 53 0 SOAP API Developer Reference August 2012 135 136 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description Amount Number Quantity Tax ItemWeight ItemLength ItemWidth ebl BasicAmountType Cost of item This field is required when you pass a value for ItemCategory NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 53 0 xs string Optional Item number Character length and limitations 127 single byte characters This field is introduced in version 53 0 xs integer Item quantity This field is required when you pass a value for ItemCategory For digital goods ItemCategory Digital this field is required Character length and limitations Any positive integer This field is introduced in version 53 0 ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which c
245. emPaymentDetailsItem request field 64 EbayltemPaymentDetailsItemType request fields 65 101 137 262 EbayItemPaymentDetailsItem Type response fields 124 EbayItemTxnld response field 179 Ebay TransactionId response field 150 Eci3ds request field 66 EciSubmitted3ds response field 70 EffectiveDate response field 180 Email request field 27 EmailSubject request field 185 EndDate request field 282 Enhanced CheckoutData request field 92 EnhancedItemData request field 101 137 EnhancedPaymentData request field 98 134 EnhancedPaymentData response field 122 EnhancedPaymentInfo response field 150 error codes 287 error responses 22 ErrorCode response field 125 152 ErrorParameters response field 125 152 EUR 369 370 Euro 369 370 ExchangeRate response field 146 175 270 ExpMonth request field 58 75 199 230 263 ExpMonth response field 214 ExpressCheckout API Operatons 79 ExpYear request field 58 75 199 230 263 ExpYear response field 215 F FailedInitialAmountAction request field 197 FailedPaymentCount response field 214 FeeAmount response field 146 175 270 286 FeeRefundAmount response field 279 FinalPaymentDueDate response field 210 FirstName request field 60 76 201 230 264 284 August 2012 393 FirstName response field 117 172 215 243 250 FlatR ateShippingOptions request field 88 FMFDetails response field 68 143 150 268 FMFDetailsType response fields 68 152 273 Forint 369 370 FundingSourceDetails
246. ence Recurring Payments and Reference Transactions API Operations 12 CreateRecurringPaymentsProfile API Operation CreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set currencyId to GBP In addition you must specify either StartMonth and StartYear or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters CreditCardNumber xs string Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type ExpMonth xs int Required Credit card expiration month Character length and limitations 2 single byte numeric characters including leading Zero ExpYear xs int Required Credit card expiration year Character length and limitations 4 single byte numeric characters CVV2 xs string Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transac
247. equest Received OrderTotal Amt Required parameter missing MaxAmt Required parameter missing ReturnURL Required parameter missing NotifyURL Required parameter missing CancelURL Required parameter missing ShipToStreet Required parameter missing ShipToStreet2 Required parameter missing ShipToCity Required parameter missing ShipToState Required parameter missing ShipToZip Required parameter missing Country Required parameter missing ReqConfirmShipping Required parameter missing NoShipping Required parameter missing AddrOverride Required parameter missing 288 August 2012 SOAP API Developer Reference API Error Codes Validation Errors Error Code Short Message Long Message 81114 Missing Parameter LocaleCode Required parameter missing 81115 Missing Parameter PaymentAction Required parameter missing 81116 Missing Parameter Email Required parameter missing 81117 Missing Parameter Token Required parameter missing 81118 Missing Parameter PayerID Required parameter missing 81119 Missing Parameter ItemAmt Required parameter missing 81120 Missing Parameter ShippingAmt Required parameter missing 81121 Missing Parameter HandlingAmt Required parameter missing 81122 Missing Parameter Tax Amt Required parameter missing 81123 Missing Parameter IPAddress Required parameter missing 81124 Missing Parameter ShipToName Required parameter missing 81125 Missing Parameter L Amt Required par
248. er length and limitations 10 single byte alphabetic characters PayerName ebl PersonNameType First and last name of buyer PayerCountry ebl CountryCodeType Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PayerBusiness xs string Buyer s business name Character length and limitations 127 single byte characters Address ns AddressType Buyer s shipping address information PayerNameType Fields Field Description Salutation xs string Buyer s salutation Character length and limitations 20 single byte characters FirstName ebl PersonNameType Buyer s first name Character length and limitations 25 single byte characters MiddleName ebl NameUser Buyer s middle name Character length and limitations 25 single byte characters SOAP API Developer Reference August 2012 243 FE Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation Field Description LastName Suffix ebl NameType Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Buyer s suffix Character length and limitations 12 single byte characters AddressType Fields Field AddressStatus Name Streetl Street2 CityName StateOrProvince PostalCode Country Description ebl AddressStatusTypeCod
249. erEmail additional error messages for details 10409 You re not authorized to Express Checkout token was issued access this info for a merchant account other than yours 10410 Invalid token Invalid token August 2012 SOAP API Developer Reference API Error Codes A SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10411 This Express Checkout This Express Checkout session has If you receive this error you session has expired expired Token value is no longer must return your buyer to valid PayPal to approve the use of PayPal again Display an error message to inform the buyer that the transaction expired and provide a button to return to PayPal In this situation you are effectively restarting the entire checkout process Do not reuse the expired token value on SetExpressCheckout request However because you already know the final OrderTotal be sure to update the value for that element if appropriate You might also want to update the values for ReturnURL and CancelURL if necessary 10412 Duplicate invoice Payment has already been made for PayPal checks that this InvoiceID InvoicelD values are unique for any particular merchant If you send an InvoicelD value already associated with another transaction in the PayPal system PayPal returns error code 10412 You might not be able to correct this error during an actual checkout If you receive this error rese
250. erName 0 1 0 1 e BuyerRegistrationDate 0 1 TaxIdDetails 0 1 IdentificationInfo 0 1 string string dateTime E IdentificationInfoType MobileIDInfo 0 1 MobileIDInfoType e RememberMeIDInfo 0 1 RememberMeIDInfoType TaxIdDetailsType IdentificationInfoType 84 NOTE Not all fields shown are available for use Use only the fields described in the documentation ie BasicAmountType OrderTotal BasicAmountType 2 currencylD CurrencyCodeType e ItemTotal BasicAmountType e ShippingTotal BasicAmountType E AddressType HandlingTotal BasicAmountType e Name 0 1 string e TaxTotal BasicAmountType e Street1 0 1 string e OrderDescription string e Street2 0 1 string e Custom string e CityName 0 1 string InvoiceID string StateOrProvince 0 1 string e ButtonSource string El Country 0 1 CountryCodeType e NotifyURL string l CountryName 0 1 string e ShipToAddress AddressType e Phone 0 1 string e ShippingMethod ShippingServiceCodeType e PostalCode 0 1 string e ProfileAddressChangeDate 0 1 dateTime e AddressID 0 1 string e PaymentDetailsItem 0 PaymentDetailsltemType e AddressOwner 0 1 AddressOwnerCodeType e InsuranceTotal 0 1 BasicAmountType e External ddressID 0 1 string e ShippingDiscount 0 1 BasicAmountType e InternationalName 0 1 string e InsuranceOptionOffered 0 1 string
251. erPaymentfethodlongDesciptian 1 string e OtherPaymentfethodIcon 1 string le OtherPaymentethodHideLabel boolean SOAP API Developer Reference e SurveyChoice 0 strina TotdType 0 1 TotalType e NoteToBuver 0 1 string Incentives 10 InceniveIn oTyps E ReqinstrumentCetails 0 1 string e ExternalrememberMedptIndetails 0 1 ExternalRememberMeCptInDetails ype e FlowContralDetails 0 1 FlowControDetaiEType DisplayControlDetails 0 1 DisplayControlDetailsType SOAP API Developer Reference August 2012 ExpressCheckout API Operations SetExpressCheckout API Operation l 3uyerdetailsType Suyerld 0 1 string 3uyer JserName 1 string 3uyertegistratiorDate 0 1 dateTime TaxIddetails 0 1 TaxIdDetailsT pe IdentificationInfo 0 1 IdentificstionInfoTy3e i PaymentDetalsType OrderTotal 0 1 BasizAmountType temTatal 0 1 BasizAmountType ShippingTotal 10 1 BasizAmountType JandlngTotal 0 1 BasizAmountType TaxTctal 0 1 Basiz mountType drderdescrption 0 1 strirg Custon 0 1 strirg InvuiueID 0 1 stri y 3uttonSource 0 1 strirg N otifyURL 0 1 strirg 5hipToAddress 0 1 Add essType ShippingMethod 0 1 ShippingServiceCodeType rofile amp ddrcssChangeDate 0 1 dateTimc JaymentDetailsltem 0 PaymentCetailsitemT pe InsuranceTotal 0 1 BasizAmountType 3hippingDiscount 0 1 Basi AmountType Insurance
252. erRegistrationDate 0 1 dateTime PayPalAccountlD 0 1 string ej SecureMerchantAccountlD 0 1 UserlDType E OfferDetails Type e OfferCode 0 1 string e BMLOfferlnfo 0 11 BMLOfferlnfoType EI RecurringFlag Type NOTE Not all fields shown are available for use Use only the fields described in the documentation E PaymentDetailsltemType ej Name 0 1 string ej Number 0 1 string e Quantity 0 1 integer e Tax 0 1 e Amount 0 1 e EbayltemPaymentDetailsitem 0 1 EbayltemPaymentDetailsltem Type e PromoCode 0 1 string el ProductCategory 0 1 ProductCategoryType 5 le Description 0 1 string e ItemWeight 0 1 e ItemLength 0 1 e ItemWidth 0 1 e ItemHeight 0 1 le ItemURL 0 1 string le EnhancedltemData 0 1 e ItemCategory 0 1 temCategoryType e ItemNumber 0 1 string e AuctionTransactionld 0 1 string e Orderld 0 1 string e CartlD 0 1 string EI ProductCategoryType 00000 3 temCategoryType NOTE Not all fields shown are available for use Use only the fields described in the documentation 54 August 2012 SOAP API Developer Reference DoDirectPayment API Operation DoDirectPayment Request Message E CreditCardDetails Type EI CreditCardTypeType CreditCardType 0 1 CreditCardTypeType E PayerlnfoType CreditCardNumbe
253. erations GetExpressCheckoutDetails API Operation GetExpressCheckoutDetails Response Message le AbstractResponselype GetExpressCheckoutDetailsResponseDetailsType el Timestamp 0 1 dateTime el Token ExpressCheckoutTokenType el Ack AckCodeType e PayerInfo PayerInfoType e CorrelationID 0 1 string e Custom 0 1 string Errors 0 ErrorType el InvoicelD 0 1 string Version string e ContactPhone 0 1 string e Build string e Biling amp greementAcceptedStatus 0 1 boolean PE any 0 1 RedirectRequired 0 1 string e BillingAddress 0 1 AddressType e Note 0 1 string CheckoutStatus 0 1 string E GetExpressCheckoutDetailsResponseType E PayPalAdjustment 0 1 BasicAmountType ses df GetExpressCheckoutDetailsResponseDetails 1 1 GetExpressCheckoutDetailsResponseDetailsType PaymentDetails 0 10 PaymentDetailsType el UserSelectedOptions 0 1 UserSelectedOptionType IncentiveDetails D IncentiveDetailsType GiftMessage 0 1 string GiftReceiptEnable 0 1 string e GiftWrapName 0 1 string e GiftWrapAmount 0 1 BasicAmountType BuyerMarketingEmail 0 1 string SurveyQuestion 0 1 string el SurveyChoiceSelected 0 string PaymentRequestInfo 0 10 PaymentRequestInfoType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference Augus
254. erchant is not enabled for reference transactions transactions Mark reference transaction Warning only August 2012 SOAP API Developer Reference GetBillingAgreementCustomerDetails Errors API Error Codes Error Code Short Message Long Message Additional Information 11453 Reference transactions Reference transaction feature not Feature not enabled because temporarily unavailable currently available try again later system is running in standin mode Warning only 11601 Request for billing address Billing address request is not failed enabled for merchant 11602 Request for billing address Feature not yet available failed GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 10408 Missing token Token is missing Token is missing 10409 You re not authorized to Express Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout session has Token expired session has expired expired Token value is no longer valid CreateBillingAgreement CreateBillingAgreement Errors Errors Error Code Short Message Long Message Additional Information 10408 Missing token Token is missing Token is missing 10409 You re not authorized to Ex
255. erence August 2012 363 TE Countries and Regions Supported by PayPal 364 August 2012 SOAP API Developer Reference State and Province Codes Canadian Province or U S State Abbreviation Alberta AB British Columbia BC Manitoba MB New Brunswick NB Newfoundland and Labrador NL Northwest Territories NT Nova Scotia NS Nunavut NU Ontario ON Prince Edward Island PE Quebec QC Saskatchewan SK Yukon YT Alabama AL Alaska AK American Samoa AS Arizona AZ Arkansas AR California CA Colorado CO Connecticut CT Delaware DE District of Columbia DC Federated States of Micronesia FM Florida FL Georgia GA SOAP API Developer Reference August 2012 365 State and Province Codes 366 Canadian Province or U S State Abbreviation Guam Hawaii Idaho Illinois Indiana Iowa Kansas Kentucky Louisiana Maine Marshall Islands Maryland Massachusetts Michigan Minnesota Mississippi Missouri Montana Nebraska Nevada New Hampshire New Jersey New Mexico New York North Carolina North Dakota Northern Mariana Islands Ohio Oklahoma Oregon Palau GU HI a a 2 d NC MP OH OK OR PW August 2012 SOAP API Developer Reference State and Province Codes Canadian Province or U S State Abbreviation Pennsylvania PA Puerto Rico PR Rhode Island RI South Carolina SC South Dakota SD Tennessee TN Texas TX Utah UT Vermont VT Virgin Islands VI Virginia VA W
256. ers Street2 xs string Optional Second street address Character length and limitations 100 single byte characters CityName xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters StateOrProvince xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters PostalCode xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address and may be required for other countries Character length and limitations 20 single byte characters Country ebl CountryCodeType Country code It is required if using a shipping address Character length and limitations 2 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters PaymentDetailsType Fields When implementing parallel payments you can create up to 10 sets of payment details type parameter fields each representing one payment you are hosting on your marketplace SOAP API Developer Reference August 2012 95 96 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description OrderTotal ItemTotal ShippingTotal InsuranceTotal ebl BasicAmount Type Required Total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this v
257. ess Checkout Express Checkout API item amount API item amount 13100 Parallel payments Parallel payments functionality is not functionality is not available available 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is Payment Request ID is mandatory missing for parallel payments 13103 Duplicate Payment Request Payment Request ID must be unique ID passed for parallel payments 13104 Transaction refused because Number of payment requests exceeds of an invalid argument See maximum number of supported Additional error messages requests for details 13105 Invalid Data Billing Agreement is not supported for parallel payments 13106 Invalid Data You cannot pass both the new and deprecated PaymentAction parameter 13108 Merchant is not eligible Merchant is not eligible for parallel payments 13110 Multi Payments Sale is Not Due to some technical diffculties the allowed Multi Payments for Sale is not avaliable now please try again later 13111 Mixed Payment action not The Payment Action passed should supported be unique mixed Payment Action not supported 13114 Buyer Didn t Complete The Buyer returned without completing the payment 13115 Seller ID Missing Seller ID is mandatory for parallel payments 13116 Transaction refused because The transaction is in progress for this of an invalid argument See additional error messages for details token August 2012 SOAP A
258. est field 282 SOAP API Developer Reference ReceiptID response field 174 269 Receiver request field 282 Receiver response field 171 ReceiverEmail request field 74 ReceiverID response field 171 ReceiverInfo response field 170 ReceiverInfoType response fields 171 ReceiverType request field 186 Recurrences response field 181 Recurring Payments API Operations 187 Recurring request field 63 261 379 recurring response field 181 RecurringPayments ProfileDetails response field 210 RecurringPayments Summary response field 210 RecurringPaymentsProfileDetails request field 193 RecurringPaymentsProfileDetailsType request fields 193 RecurringPaymentsProfileDetailsType response fields 211 RecurringPaymentsSummaryDetailsType response fields 213 RedirectRequired response field 115 142 Reference Transactions API Operations 187 ReferenceID request field 245 255 RefundAdvice request field 277 RefundInfo request field 279 RefundItemDetails request field 277 RefundSource request field 277 RefundStatus request field 280 RefundTransaction API operation 275 RefundTransaction request fields 276 RefundTransaction request message 275 RefundTransaction response fields 278 RefundTransaction response message 278 RefundTransactionID response field 278 RefundType request field 276 378 ReportsFilters response field 69 152 273 ReqConfirmShipping request field 88 256 request structure 19 RequesterCredentials 17 response structure 21 Re
259. estDetailsType fe AbstractRequestType e DetailLevel 0 DetaillevelCodeType el ProfileID 1 1 string e ErrorLanguage 0 1 string el Amount 0 1 BasicAmountType e Version string el Note 0 1 string F any 0 1 E BillOutstandingAmountRequestType 20a E BillOutstandingAmountRequestDetails BillOutstandingAmountRequestDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation BillOutstandingAmountRequestDetailsType BasicAmountType e ProfileID 1 1 string a currencyID CurrencyCodeType see e Amount 0 1 BasicAmountType e Note 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation BillOutstandingAmount Request Fields Field Description ProfileID xs string Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response NOTE The profile must have a status of either Active or Suspended Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API SOAP API Developer Reference August 2012 219 220 Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation Field Description Amount cc BasicAmountType Optional The amount to bill The amount must be less
260. estion 0 1 string EE Country 1 CountryCede yre SurveyChoceSelected 0 string sl CountryName 41 string E Payrren Requestinfo 0 10 PaynertRequestInfoType e Phone 4 string e ExternaRenemberMeS atusCetails 0 ExternelRememberMestatusDetailsType PostalCode ul string e AddressID A string AddressOwner AddressOwnerCodeT ype e ExternalAddressID 1 string Inte nationaldame ul string E Inte nationalStateAndcity 1 string Inte nationalStreet ul string e AddressStatus 1 AddressStatusCodeType la Basic moun Type 3 currencylD CurercyCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation 108 August 2012 SOAP API Developer Reference ExpressChecko GetExpressCheckoutDetails API Operation ut API Operations E PaymentDetailsType E OrderTotal ItemTotal e ShippingTotal HandlingTotal TaxTotal OrderDescription Custom InvoicelD ButtonSource NotifyURL ShipToAddress e ShippingMethod e ProfileaddressChangeDate PaymentDetailsItem InsuranceTotal ShippingDiscount InsuranceOptionOffered AllowedPaymentMethod e EnhancedPaymentData e SellerDetails NoteText TransactionId PaymentAction PaymentRequestID OrderURL e SoftDescriptor e OfferDetails BasicAmountT
261. etails API Errors GetTransactionDetails API Errors GetTransactionDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10004 Transaction refused because of an Store ID is required if Terminal ID is specified invalid argument See additional error messages for details TransactionSearch API Errors TransactionSearch API Errors Error Code Short Message Long Message 10001 10001 10003 10004 10004 10004 10004 Internal Error ButtonSource value truncated Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Internal Error The transaction could not be loaded Start date is a required parameter Start date is invalid End date is invalid Currency is not supported Transaction class is not supported SOAP API Developer Reference August 2012 331 API Error Codes TransactionSearch API Errors Error Code Short Message Long Message 10004 10004 10004 10004 10004 1000
262. evel 0 DetaillevelCodeType amp ErrorLanguage 0 1 string FMFPendingTransactionActionType Version string f any 0 1 ManagePendingTransactionStatusRequestType e TransactionID TransactionId e Action FMFPendingTransactionActionT ype NOTE Not all fields shown are available for use Use only the fields described in the documentation ManagePendingTransactionStatus Request Fields Field Description TransactionID Required The transaction ID of the payment transaction Action Required The operation you want to perform on the transaction It is one of the following values e Accept Accepts the payment e Deny Rejects the payment SOAP API Developer Reference August 2012 183 Po ManagePendingTransactionStatus API Operation ManagePendingTransactionStatus Response Message ManagePendingTransactionStatus Response Message 1 AbstractResponseType TE ManageRecurringPaymentsProfileStatusResponseDetailsType Timestamp 0 1 dateTime ProfileID 1 1 string el Ack AckCodeType e CorrelationID 0 1 string e Errors 0 ErrorType e Version string Build string PE any 0 1 E ManageRecurringPaymentsProfileStatusResponseType HF ManageRecurringPaymentsProfileStatusResponseDetalls ManageRecurringPaymentsProfileStatusResponseDetailsType NOTE Not all fields shown are available for use Use only the fields des
263. ext experience NOTE PayPal recommends that the value be the original page on which the buyer chose to pay with PayPal or establish a billing agreement Character length and limitations 2048 single byte characters xs string Optional URL to which the callback request from PayPal is sent It must start with HTTPS for production integration It can start with HTTPS or HTTP for sandbox testing Character length and limitations 1024 single byte characters This field is available since version 53 0 int Optional An override for you to request more or less time to be able to process the callback request and respond The acceptable range for the override is 1 to 6 seconds If you specify a value greater than 6 PayPal uses the default value of 3 seconds Character length and limitations An integer between 1 and 6 SOAP API Developer Reference August 2012 87 88 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Address deprecated ReqConfirmShipping NoShipping FlatRateShippingOpt ions AllowNote PaymentDetails ebl AddressType Optional Buyer s shipping address If you include a shipping address and set the AddressOverride element on the request PayPal returns this same address in GetExpressCheckoutDetailsResponse This field is deprecated since version 53 0 Use ShipToAddress in PaymentDetailsType instead xs string Indicates whetheror not you require the
264. ference Transactions API Operations DoReferenceTransaction API Operation AddressType Shipping Fields Field Description Name Streetl Street2 CityName StateOrProvince PostalCode Country Phone xs string Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters xs string First street address It is required if using a shipping address Character length and limitations 100 single byte characters xs string Optional Second street address Character length and limitations 100 single byte characters xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters ebl CountryCodeType Country code It is required if using a shipping address Character length and limitations 2 single byte characters xs string Optional Phone number Character length and limitations 20 single byte characters 258 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions A
265. fields described in the documentation SetExpressCheckout Response Fields Field Description Token xs string A timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout The token expires after three hours If you set the token in the SetExpressCheckout request the value of the token in the response is identical to the value in the request Character length and limitations 20 single byte characters SOAP API Developer Reference August 2012 105 o ExpressCheckout API Operations GetExpressCheckoutDetails API Operation GetExpressCheckoutDetails API Operation The GetExpressCheckoutDetails API operation obtains information about an Express Checkout transaction GetExpressCheckoutDetails Request Message f AbrfractReguest Type ExpressCheckoutTokenType gt DetailLewel 0 DetaillevelCodeType gt ErrorLanguage 0 1 string Version string P any 0 1 etExpressCheckoutDetailsRequestType ses e Token 1 1 ExpressCheckoutTokenType NOTE Not all fields shown are available for use Use only the fields described in the documentation GetExpressCheckoutDetails Request Fields Field Description Token xs string Required A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters 106 August 2012 SOAP API Developer Reference ExpressCheckout API Op
266. g e Address 0 1 AddressType e ContactPhone 0 1 string E AddressType e Name 1 string e Street1 1 string e Street2 1 string e CityName 1 string e StateOrProvince 1 string EE Country ul CountryCodeType CountryName 1 string e Phone 1 string e PostalCode 1 string e AddressID 1 string e AddressOwner ul AddressOwnerCodeType e ExternalAddressID ul string InternationalName ul string InternationalStateAndCity 0 1 string e InternationalStreet ul string e AddressStatus ul AddressStatusCodeType NOTE Not all fields shown are available for use Only use fields described in the documentation SOAP API Developer Reference August 2012 241 242 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation E PayerInfoType El EmailAddressType 8 UserlDType E PayPalUserStatusCodeType E PersonNameType e Payer 0 1 EmailaddressType e PayerID 0 1 UserIDType e PayerStatus 0 1 PayPalUserStatusCodeType e PayerName PersonNameType e PayerCountry 0 1 CountryCodeType e PayerBusiness 0 1 string e Salutation 0 1 SalutationType e Address 0 1 AddressType e ContactPhone 0 1 string E FirstName 0 1 NameType e MiddleName 0 1 NameType e LastName 0 1 MameType e Suffix 0 1 SuffixType E CountryC
267. g All currency amount fields have the following structure 1 The currencyID attribute is required 2 The amount must have two decimal places August 2012 SOAP API Developer Reference PayPal SOAP API Basics Core Currency Amount Data Type 3 The decimal separator must be a period 4 You must not use any thousands separator 5 BasicAmountType has a data type of eb1 CurrencyCodeType which defines a large number of different currency codes However for your processing to succeed you must set currencyCode to a valid currency code Some APIs support only a subset of currencies Here is an example The field name Amount is an example actual field names can vary depending on the specific API Amount currencyID currencyCode gt 3 00 Amount SOAP API Developer Reference August 2012 25 FE PayPal SOAP API Basics Core Currency Amount Data Type 26 August 2012 SOAP API Developer Reference AddressVerify API Operation The AddressVerify API operation confirms whether a postal address and postal code match those of the specified PayPal account holder AddressVerify Request Message fe AbstractRequestType i Email ddressType Detaillevel 0 DetaillevelCodeType el ErrorLanguage 0 1 string e Version string F any 0 1 AddressVerifyRequestType e Email Email ddressType ses e Street string e Zip string NOTE Not all fields shown are available for us
268. g DL D U Desc mountT pe string NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference Ig TranzactionID FaynerthtoType ExpressCheckout API Operations DoExpressCheckoutPayment API Operation la Iransactinnt 4l suirg LE ChayTiansactionIC suirg a Payment Iransactiont od2 pe e FarentTicibaclu oO 041 Trausa liv Id FlfeepD 0 1 sirg 3 PeymentccdeTpe Iransactinn ypa Payment Iransarherk nde yre A Fas nent Ins 2H4 1 Payment nda ype El Ref ndsourcecose ype E ReFundSeurceCodeType 0 1 PetuncSosrceCodeTyp gt Le ExpscbedeChed ClsarC ate da eTine did 8 raynertBete da cTimo 8 Grass meun Basiz mountT pc ETT ert 1 PeymenttatueCodeTyse E Fee noant 70 1 DasizAmountType e Slem k 0 1 Basi AnuunlType PendinaStatusCodaType e Taxanount 10 1 BaslcAmountTvpe fel ExchanceRa e 0 1 sro BeversalkeasonCoceTvpe Fay menr ratik PAymantrahist arel ype IL m E FendingReason 0 1 PeudiigSta usloadeType E sellerCetaikType e Fe onCoce 10 1 RevarsaReazorCodaType Y x 1 de 8 Sollor1d 0 string Hcldbece cn 41 sir ree nem J E SellsrUse Hame 0 string Shippir oc 41 si in tel du m 1 y e SellsiRieuisLrdiuniDaLz 0 deles FrotectionCligi gt iity 0 1 suirg z E PayPa AczourtiC 0 string FrulealivnEl
269. g address must match the buyer s country of residence PaymentAction of Authorization is not allowed with Unilateral and Non Credentialed authentication This transaction couldn t be completed Please redirect your customer to PayPal PaymentAction of Order is not allowed with Unilateral and Non Credentialed authentication The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings The transaction was refused because the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings Payment declined by your Risk Controls settings PayPal Risk Model There was an error in the Shipping Address Country field The field Shipping Address1 is required The buyer selects the country of residence when they sign up for their PayPal account The country of residence displays after the dash in the title on the Account Overview page Redirect the buyer back to PayPal using the original token so that the customer can use or add a new funding instrument SOAP API Developer Reference August 2012 323 324 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10728 Shipping Address City The field Shipping Address Empty City is required 10729 Shipping Address State The field Shipping Address Empty State is required 10730 Shipping Address Postal The fie
270. g address request is not enabled failed for merchant 11602 Request for billing address Feature not yet available failed 11801 Invalid Data You cannot pass both new and deprecated parameter address fields August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11802 11803 11804 11805 11806 11807 11810 11811 11812 11813 11814 11815 Invalid Data Invalid Data Invalid Data Invalid Data Invalid Data Invalid Data Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Invalid Data Transaction refused because of an invalid argument See additional error messages for details Callback URL is wrong type Invalid data Transaction refused because of an invalid argument See additional error messages for details Callback options missing You cannot pass both the new and deprecated Custom parameter You cannot pass both the new and deprecated Invoice ID parameter You cannot pass both the new and deprecated order description You cannot pass both the new and deprecated order total or amount parameters You cannot pass both the new and deprecated Profile AddressChangeDate parameter You cannot pass both the new and deprecate
271. g error state in the shipping address message tells you which field is invalid 10724 Invalid Data There s an error with this There was a problem with a particular transaction Please enter your field in the address The long error five digit postal code in the message tells you which field is invalid shipping address 10725 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error country in the shipping address message tells you which field is invalid 10726 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a field in the address The long error complete shipping address message tells you which field is invalid 10726 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a field in the address The long error complete shipping address message tells you which field is invalid 10727 Invalid Data There s an error with this There was a problem with a particular transaction Please enter an address1 in the shipping address field in the address The long error message tells you which field is invalid August 2012 SOAP API Developer Reference API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10727 Invalid Data 10728 Invalid Data 10728 Invalid Data 10729 Invalid Data
272. gAgreementDetails 1 1 Biling greementDetailsType BilingType 1 1 BilingCodeType ReturnURL ul string e BilingAgreementDescription 0 1 string CancelURL ul string e PaymentType 0 1 MerchantPullPaymentCodeType LocaleCode 1 string e BillingAgreementCustom 0 1 string PageStyle 1 string cpp header image 1 string E EmailAddressType cpp header border color 0 1 string cpp header back color ul string cpp payflow color ul string BuyerEmail 1 Email ddressType e e e e e e e e e e e RegBillingAddress ul string NOTE Not all fields shown are available for use Use only the fields described in the documentation SetCustomerBillingAgreement Request Fields Field Description BillingAgreement ns BillingAgreementDetailsType Details Required Details of the billing agreement such as the billing type billing agreement description and payment type SOAP API Developer Reference August 2012 233 FE Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description ReturnURL xs string Required URL to which the buyer s browser is returned after choosing to pay with PayPal NOTE PayPal recommends that the value be the final review page on which the buyer confirms the billing agreement Character length and limitations no limit Cancel URL xs string Requ
273. geRecurringPaymentsProfileStatusRequestDetails ManageRecurringPaymentsProfileStatusRequestDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation ManageRecurringPaymentsProfileStatus Request Fields Field Description ProfileID xs string Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API Action ns StatusChangeActionType Required The action to be performed to the recurring payments profile Must be one of the following e Cancel Only profiles in Active or Suspended state can be canceled e Suspend Only profiles in Active state can be suspended e Reactivate Only profiles in a suspended state can be reactivated Note xs string Optional The reason for the change in status For profiles created using Express Checkout this message is included in the email notification to the buyer when the status of the profile is successfully changed and can also be seen by both you and the buyer on the Status History page of the PayPal account SOAP API Developer Reference August 2012 217 Fe Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation ManageRecurringPaymentsProfileStatus Response Message
274. ged on payment August 2012 SOAP API Developer Reference GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description Payment Item ebl Payment ItemType Amount of tax charged on payment Subscription ebl SubscriptionInfoType Subscription information Auction ebl AuctionInfoType Subscription information PaymentltemType Fields Field Description EbayItemTxnId Name Number Quantity CouponID CouponAmount CouponAmountCurrenc y LoyaltyCardDiscount Amount xs string Optional The eBay auction transaction ID of the item that you use to identify items that the buyer purchased Character length and limitations 255 single byte characters xs string Item name set by you or entered by the customer NOTE Character length and limitations 127 single byte alphanumeric characters xs string Item number set by you If this was a shopping cart transaction PayPal appends the number of the item to the HTML item number variable for example item number1l item number2 and so forth Character length and limitations 127 single byte alphanumeric characters xs string Quantity set by you or entered by the buyer Character length and limitations no limit xs string Optional Coupon identification number xs string Optional Amount value of the coupon xs string Optional Currency of the coupon amount e g a 3 character currency code xs string
275. gle byte characters xs string Second street address Character length and limitations 100 single byte characters xs string Name of city Character length and limitations 40 single byte characters xs string State or province Required for U S addresses only Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters ns CountryCode Country code Character length and limitations 2 single byte characters xs string Expanded name of country Character length and limitations 64 single byte alphanumeric characters xs string Phone number Character length and limitations 20 single byte characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 ManageRecurringPaymentsProfileStatus API Operation ManageRecurringPaymentsProfileStatus API Operation The ManageRecurringPaymentsProfileStatus API operation cancels suspends or reactivates a recurring payments profile ManageRecurringPaymentsProfileStatus Request Message ManageRecurringPaymentsProfileStatusRequestDetailsType DetailLevel 0 DetaillevelCodeType el ProfileID 1 1 string e ErrorLanguage 0 1 string el Action 1 1 StatusChange ctionType el Version string e Note 0 1 string F any 0 1 A ManageRecurringPaymentsProfileStatusRequestType sss E Mana
276. gth and limitations 100 single byte characters CityName xs string Required Name of city Character length and limitations 40 single byte characters StateOrProvince xs string Required State or province Character length and limitations 40 single byte characters Country ebl CountryCodeType Required Country code Character length and limitationst 2 single byte characters PostalCode xs string Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters SOAP API Developer Reference August 2012 201 FE Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation PaymentDetailsltemType Fields Field Description ItemCategory Name Description Amount Number Quantity ns ItemCategoryType Indicates whether the item is digital or physical For digital goods this field is required and must be set to Digital to get the best rates Is one of the following values e Digital e Physical This field is introduced in version 69 0 xs string Item name This field is required when ItemCategory is passed Character length and limitations 127 single byte characters This field is introduced in version 69 0 xs string Optional Item description Character length and limitations 127 single
277. gth and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma FailedInitialAmount ns FailedPaymentAction Action Optional Action you can specify when a payment fails It is one of the following values e ContinueOnFailure By default PayPal suspends the pending profile in the event that the initial payment amount fails You can override this default behavior by setting this field to Cont inueOnFailure Then if the initial payment amount fails PayPal adds the failed payment amount to the outstanding balance for this recurring payment profile When you specify Cont inueOnFailure a success code is returned to you in the CreateRecurringPaymentsProfile response and the recurring payments profile is activated for scheduled billing immediately You should check your IPN messages or PayPal account for updates of the payment status e CancelOnFailure If this field is not set or you set it to CancelOnFailure PayPal creates the recurring payment profile but places it into a pending status until the initial payment completes If the initial payment clears PayPal notifies you by IPN that the pending profile has been activated If the payment fails PayPal notifies you by IPN that the pending profile has been canceled SOAP API Developer Reference Augu
278. h maximum length is 256 argument See additional error messages for details 10433 Transaction refused Value of OrderDescription element OrderDescription field is too because of an invalid has been truncated long maximum length is 127 argument See additional Warning only API executes error messages for details 10434 Transaction refused Value of Custom element has been Custom field is too long because of an invalid argument See additional error messages for details truncated maximum length is 256 Warning only API executes August 2012 SOAP API Developer Reference API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10441 10442 10504 10527 10537 10538 10539 10546 10560 10567 10600 10601 10621 10622 10623 Transaction refused because of an invalid argument See additional error messages for details ButtonSource value truncated The cvv2 is invalid Invalid Data Risk Control Country Filter Failure Risk Control Max Amount Failure Payment declined by your Risk Controls settings PayPal Risk Model Gateway Decline Invalid Data Invalid Data Authorization voided Authorization expired Order has expired Order is voided Maximum number of authorization allowed for the order is reached The NotifyURL element value exceeds maximum allowable length The ButtonSource elemen
279. h and limitations 25 single byte characters GiftWrapAmount ebl BasicAmounttType Optional Amount only if the buyer selected the gift option on the PayPal pages NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma BuyerMarketingEmail ebl EmailAddressType Optional The buyer email address opted in by the buyer on the PayPal pages Character length and limitations 127 single byte characters SOAP API Developer Reference August 2012 129 130 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SurveyQuestion xs string Optional Survey question on the PayPal pages Limitations 50 single byte characters SurveyChoiceSelecte xs string d Optional Survey response that the buyer selected on the PayPal pages Character length and limitations 15 single byte characters ButtonSource xs string Optional Identification code for use by third party applications to identify transactions Character length and limitations 32 single byte alphanumeric characters AddressType Fields Field Description Name xs string Person s nam
280. he reason for the update to the recurring payments profile This message is included in the email notification to the buyer for the recurring payments profile update This note can also be seen by both you and the buyer on the Status History page of the PayPal account Description xs string Optional Description of the recurring payment Character length and limitations 127 single byte alphanumeric characters SubscriberName xs string Optional Full name of the person receiving the product or service paid for by the recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters SubscriberShipping ns AddressType Address Optional The subscriber s shipping address associated with this profile if applicable If you do not specify it the ship to address from buyer s PayPal account is used NOTE Shipping Address is optional but if you update any of the address fields you must enter all of them For example if you want to update the subsriber s street address you must specify all of the fields listed in ShipTo AddressType not just the field for the street address ProfileReference xs string Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters AdditionalBilling xs int Cycles Optional The number of additional billing cycles to add to this profile S
281. heckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description ReasonCode ebl ReasonCodeType Reason for a reversal if TransactionType is reversal It is one of the following values Reason for a reversal if TransactionType is reversal You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none No reason code e chargeback A reversal has occurred on this transaction due to a chargeback by your buyer e guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee e buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer e refund reversal has occurred on this transaction because you have given the buyer a refund e other A reversal has occurred on this transaction due to a reason not listed above HoldDecision xs string Reason that this payment is being held It is one of the following values Reason that this payment is being held You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e newsellerpaymenthold This is a new merchant e paymenthold A hold is placed on the merchant s transaction for a reason not listed This field is available since version 71 0 and is returned only if PaymentStatus is Completed Funds Held This field is available since version 71
282. heckoutDetails API Operation Field Description PayerStatus PayerName PayerCountry PayerBusiness Address TaxIdDetails ebl PayPalUserStatusCodeType Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters ebl PersonNameType First and last name of buyer ebl CountryCodeType Buyer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations 2 single byte characters xs string Buyer s business name Character length and limitations 127 single byte characters xs string Buyer s shipping address information ns TaxIdDetailsType Details about the buyer s tax information This field is introduced in API version 72 0 PayerNameType Fields Field Description Salutation FirstName MiddleName LastName Suffix xs string Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Buyer s suffix Character length and limitations 12 single byte characters SOAP API Developer Reference A
283. horization and Capture API Operation Reference EN DoAuthorization API Operation Field Description MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 DoAuthorization Response Message te AbstractResponseType i BasicAmountType Timestamp 0 1 dateTime 3 currencylD CurrencyCodeType Ack AckCodelype CorrelationID 0 1 string AuthorizationinfoType Errors 0 ErrorType PaymentStatus PaymentStatusCodeType Version string e PendingReason 0 1 PendingStatusCodeType Build string Protection ligibility 0 1 string f any ProtectionEligibilityType 0 1 string DoAuthorizationResponseType TransactionID 1 1 string Amount 1 1 BasicAmountType i AuthorizationInfo 0 1 AuthorizationInfoType E MsgSubID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation DoAuthorization Response Fields Field Description TransactionID xs string Authorization identification number Amount ebl BasicAmountType Amount you specified in th
284. id Parameter L_TaxAmt Invalid parameter 81229 Invalid Parameter CompleteType Invalid parameter 81230 Invalid Parameter CurrencyCode Invalid parameter August 2012 SOAP API Developer Reference API Error Codes A DirectPayment API Errors Error Code Short Message Long Message 81232 81234 81235 81236 81237 81238 81239 81243 81244 81245 81247 81248 81249 81250 81251 99998 Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Internal Error TransactionEntity Invalid parameter ExpDate Invalid parameter FirstName Invalid parameter LastName Invalid parameter Street Invalid parameter Street2 Invalid parameter City Invalid parameter RefundType Invalid parameter StartDate Invalid parameter EndDate Invalid parameter CreditCardType Invalid parameter Username Invalid parameter Password Invalid parameter Version Invalid parameter Internal Service Error Transaction refused because of an Currency is not supported invalid argument See additional error messages for details DirectPayment API Errors DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10102 10401 PaymentAction of Order Temporarily Unavailable Tra
285. ield 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 Item Total reque stfield 61 Item Total request field 96 131 259 384 Item Total response field 119 ItemURL request field 100 137 Item Weight request field 100 136 Item Weight response field 123 Item Width 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 Maestro AVS response codes 372 Maestro CVV2 response codes 373 Malaysian Ringgit 369 ManagePendingTransactionStatus API operation 183 SOAP API Developer Reference 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 ManageRecurr
286. igistity Tape 0 41 si em n e Sea reMerzharkaccojntID 0 UserlLTyse el Slip amp ucuri 70 1 sei yu e ship andiea nont 20 1 srg E FNFCetaieType Shirt iscuinr 2H 1 rg IB Arinan TEST E ccestrilters D 1 IsTiker istTyne e sui PET s Perdrg Ite 0 1 sViker istTy2 Subjec 0 1 sirg i dec RETETE E DenyAllers 0 1 RssFiker isl Ty je ZellerDe ailz 70 ler2ataileTypa ar s m 70 1 st e RepcrtFilters 0 1 3s Fiker IstTyae ay nent cquas 0 1 suirg 8 FMFCctails 10 41 RYFDe ails7ype A ts PaharradPaymert Inn lyn CrhancecPaymentinfo 70 1 Emanced axmertirfo ype pe e UATPEctais 0 0 el Fay ie LEr tur 0 1 ErrurTyLe e Instrunent2stalls 20 1 Inst umertDetalsTy3e EriurType E offerterals re E Shrrimessage sting E LengWesszge LO L sting i 2 ErrorCode token E Severi Cede Severity CodsTepe trroMarcmeters 0 EromararcterType Error 0 Erom tert E 1 istrur iei LDeldlsTyps E Instr imsntCarecoev 711 1 lt nrg amp Offer2staileType e Offsicude 0 0 slim e BHLOfTerInfu FO BMLOfTertuf Type NOTE Not all fields shown are available for use Use only the fields described in the documentation i Eran ifo Ty pe E Mhay Paver n ype E Credt pricacaFecied 1 1 son we e ElspParard 2 1 EbaPayerliluTpe ar SOAP API Developer Reference August 2012 141 ExpressCheckout API Operations DoExpressCheckoutPayment API
287. ilsType Fields les 68 RiskFilterListType Fields o e oe aa 69 ThreeDSecure Response Fields 0 0 2 70 Chapter 5 DoNonReferencedCredit API Operation 71 DoNonReferencedCredit Request Message vr lll len 71 DoNonReferencedCredit Request Fields arr ar rav rak rann 73 CreditCardDetails Type Fields o o ee 75 PayerNameType Fields llle 76 PayerlntoType Fields ran 76 4 August 2012 SOAP API Developer Reference Contents E AddressType Fields ln 77 DoNonReferencedCredit Response Message lll eee 78 DoNonReferencedCredit Response Fields 78 Chapter 6 ExpressCheckout API Operations 79 SetExpressCheckout API Operation varar vr rn kr nn aka 79 SetExpressCheckout Request Message 0 lll 79 SetExpressCheckout Response Message 0 e eae 105 GetExpressCheckoutDetails API Operation 0 2 0000 eae 106 GetExpressCheckoutDetails Request Message rn 106 GetExpressCheckoutDetails Response Message 107 DoExpressCheckoutPayment API Operation rar 126 DoExpressCheckoutPayment Request Message 126 DoExpressCheckoutPayment Response Message 139 Chapter7 GetBalance API Operation
288. immediately charged Character length and limitations 256 single byte alphanumeric characters InvoiceID xs string Optional Your own invoice or tracking number NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters ButtonSource deprecated xs string Optional An identification code for use by third party applications to identify transactions Optional An identification code for use by third party applications to identify transactions You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 32 single byte alphanumeric characters ButtonSource is deprecated since version 63 0 Use ButtonSource in the DoExpressCheckout Payment request fields instead SOAP API Developer Reference August 2012 133 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description NotifyURL ShipToAddress PaymentDetailsItem EnhancedPaymentData NoteText SoftDescriptor SellerDetails TransactionId AllowedPaymentMethodType xs string Optional Your URL for receiving Instant Payment Notification IPN about this transaction If you do not specify this value in the request the notification URL from your Merchant Profile is
289. inactive 10009 Transaction refused This transaction already has a chargeback filed 10009 Transaction refused You have not filled out the Direct Debit Instruction 10011 Invalid transaction id value Transaction refused because of an invalid transaction id value 10755 Unsupported currency Currency is not supported 11603 Conflict with prior request One or more critical fields in the with same Message request conflict with prior message Submission ID with the same Message Submission ID specified in MSGSUBID parameter 11604 Request for Message Request for the specified Message Retry the request at a later Submission ID already in Submission ID specified in time progress MSGSUBID parameter cannot be started until the previous request finishes 11607 Duplicate request for The specified Message Submission ID Retry the request at a later specified Message specified in MSGSUBID parameter is time Submission ID a duplicate result parameters of the original request are attached 11996 Use Adaptive Payment To do arefund on an Adaptive Payment Refund API transaction please use the Adaptive Payment Refund API 12302 Dispute Refund Not This transaction already has a PayPal Allowed dispute filed 13513 Duplicate request for The specified Invoice ID is a duplicate specified Invoice ID 13531 Funding source provided The funding source provided for this for this operation is not operation is not supported Please supported provide a vali
290. inese for Taiwan only Any other value defaults to US Character length and limitations 2 single byte characters PageStyle xs string Optional Sets the Custom Payment Page Style for payment pages associated with this button link This value corresponds to the HTML variable page style for customizing payment pages The value is the same as the Page Style Name you chose when adding or editing the page style in your PayPal account Character length and limitations 30 single byte alphabetic characters SOAP API Developer Reference August 2012 235 FE Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description cpp header image cpp header border cpp header back color cpp payflow color BuyerEmail xs string Optional A URL for the image you want to appear at the top left of the payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored on a secure https server Character length and limitations 127 single byte alphanumeric characters xs string Optional Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high Character length and limitations 6 character HTML hexadecimal color code in ASCII xs string Optional Sets the background color for the header of
291. ing 81147 Missing Parameter CreditCardType Required parameter missing 81148 Missing Parameter User Required parameter missing 81149 Missing Parameter Pwd Required parameter missing 81150 Missing Parameter Version Required parameter missing 81200 Missing Parameter Amt Invalid parameter 81201 Invalid Parameter MaxAmt Invalid parameter 81203 Invalid Parameter NotifyURL Invalid parameter 81205 Invalid Parameter ShipToStreet Invalid parameter 81206 Invalid Parameter ShipToStreet2 Invalid parameter 81207 Invalid Parameter ShipToCity Invalid parameter 81208 Invalid Parameter ShipToState Invalid parameter 81209 Invalid Parameter ShipToZip Invalid parameter 81210 Invalid Parameter Country Invalid parameter 81211 Invalid Parameter ReqConfirmShipping Invalid parameter 81212 Invalid Parameter Noshipping Invalid parameter 81213 Invalid Parameter AddrOverride Invalid parameter 81214 Invalid Parameter LocaleCode Invalid parameter 81215 Invalid Parameter PaymentAction Invalid parameter 81219 Invalid Parameter ItemAmt Invalid parameter 81220 Invalid Parameter ShippingAmt Invalid parameter 81221 Invalid Parameter HandlingTotal Amt Invalid parameter 81222 Invalid Parameter TaxAmt Invalid parameter 81223 Invalid Parameter IPAddress Invalid parameter 81224 Invalid Parameter ShipToName Invalid parameter 81225 Invalid Parameter L Amt Invalid parameter 81226 Invalid Parameter Amt Invalid parameter 81227 Inval
292. ing amp greementCustom 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation BAUpdate Request Fields Field Description ReferenceID xs string Required An ID such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement BillingAgreementSta ebl MerchantPullStatusCodeType tus Optional Use to cancel a billing agreement To cancel a billing agreement pass the value Canceled NOTE If you do not pass the value Canceled BAUpdate returns the buyer s latest billing address SOAP API Developer Reference August 2012 245 FE Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description BillingAgreement xs string Description Optional Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer will be billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters BillingAgreement xs string Custom Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric characters BAUpdate Response Message N
293. ingPaymentsProfileStatus 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 MassPayltem request field 186 MasterCard AVS response codes 371 MasterCard CV V2 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 Mpi Vendor3ds request field 66 MsgSubID request field 33 36 41 42 257 268 277 279 Multiltem 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 August 2012 395 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 req
294. ingProfile The system is in the process of creating the recurring payment profile Please check your IPN messages for an update SOAP API Developer Reference August 2012 203 204 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation GetRecurringPaymentsProfileDetails API Operation The GetRecurringPaymentsProfileDetails API operation obtains information about a recurring payments profile GetRecurringPaymentsProfileDetails Request Message te AbstractRequestType e DetailLevel 0 DetailLevelCodeType e ErrorLanguage 0 1 string e Version string 2 any 0 1 GetRecurringPaymentsProfileDetailsRequestType ceo e ProfileID string NOTE Not all fields shown are available for use Use only the fields described in the documentation GetRecurringPaymentsProfileDetails Request Fields Field Description ProfileID xs string Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response 19 character profile IDs are supported for compatibility with previous versions of the PayPal API Character length and limitations 14 single byte alphanumeric characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation GetRecurringPaymentsProfileDetails Response Message le AbstractResponse Type Timestamp Ack
295. ion Field Description EnhancedItemData ed EnhancedItemDataType Optional Enhanced data for each item in the cart For eBay use only ItemCategory ns ItemCategoryType Indicates whether an item is digital or physical For digital goods this field is required and must be set to Digital It is one of the following values e Digital e Physical This field is available since version 65 1 SellerDetailsType Fields Field Description PayPalAccount ID xs string Unique identifier for the merchant For parallel payments this field is required and must contain the Payer Id or the email address of the merchant Character length and limitations 127 single byte alphanumeric characters EbayltemPaymentDetailsltemType Fields Field Description ItemNumber xs string Optional Auction item number Character length 765 single byte characters AuctionTransactionId xs string Optional Auction transaction identification number Character length 255 single byte characters OrderID xs string Optional Auction order identification number Character length 64 single byte characters Cart ID xs string Optional The unique identifier provided by eBay for this order from the buyer Character length 255 single byte characters SOAP API Developer Reference August 2012 101 o ExpressCheckout API Operations SetExpressCheckout API Operation BuyerDetailsType Fields Field Description BuyerId Buye
296. ion 69 E Field Description Tax New field ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD Changes to PaymentDetailsltemType in DoReferenceTransaction Request PaymentDetailsltemType Fields Field Description ItemCategory New field ns ItemCategoryType Indicates whether the item is digital or physical goods For digital goods this field is required and you must set it to Digital to get the best rates It is one of the following values e Digital e Physical Name xs string Item name This field is required when you pass a value for ItemCategory Character length and limitations 127 single byte characters Amount ebl BasicAmountType Cost of item This field is required when you pass a value for ItemCategory NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator must be a period and the optional thousands separ
297. ionID amp EbayTransactionID ParentTransactionID JE ReceiptID TransactionType PaymentType RefundSourceCodeType ExpectedeCheckClearDate PaymentDate Gross mount e FeeAmount e SettleAmount TaxAmount ExchangeRate PaymentStatus PendingReason ReasonCode HoldDecision e ShippingMethod ProtectionEligibility e ProtectionEligibilityType e ShipAmount ShipHandleAmount e ShipDiscount InsuranceAmount e Subject e SellerDetails PaymentRequestID e FMFDetails EnhancedPaymentInfo PaymentError InstrumentDetails OfferDetails string string TransactionId string PaymentTransactionCodeType PaymentCodeType RefundSourceCodeType dateTime dateTime BasicAmountType BasicAmountType BasicAmountType BasicAmountType string PaymentStatusCodeType PendingStatusCodeType ReversalReasonCodeType string string string string string string string string string SellerDetailsType string FMFDetailsType EnhancedPaymentInfoType ErrorType InstrumentDetailsType OfferDetailsType 163 pg GetTransactionDetails API Operation GetTransactionDetails Response Message PaymentItemInfoType e InvoiceID 0 1 string e Custom 0 1 string e Memo 0 1 string SalesTax 0 1 string e PaymentItem 0 PaymentItemType e Subscription 0 1
298. ional Type of PayPal payment you require for the billing agreement It is one of the following values e Any e InstantOnly NOTE For recurring payments this field is ignored BillingAgreement xs string Custom Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes TaxldDetailsType Type Fields Field Description TaxIdType xs string Buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR CPF for individuals and BR CNPJ for businesses This field is introduced in API version 72 0 TaxId xs string Buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte characters for individuals and 14 single byte characters for businesses This field is introduced in API version 72 0 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CN SetExpressCheckout API Operation SetExpressCheckout Response Message te AbstractResponseType ExpressCheckoutTokenType e Timestamp 0 1 dateTime gt Ack AckCodeType gt CorrelationID 0 1 string gt Errors 0 ErrorType gt Version string e Build string any SetExpressCheckoutResponseType ses e Token ExpressCheckoutTokenType NOTE Not all fields shown are available for use Only use
299. ired URL to which the customer is returned if he does not approve the use of PayPal to pay you NOTE PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement Character length and limitations no limit 234 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 SetCustomerBillingAgreement API Operation Field Description LocaleCode xs string Optional Locale of pages displayed by PayPal during checkout PayPal supports the following 2 character country codes e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 character codes are also supported for languages in specific countries da DK Danish for Denmark only he IL Hebrew all id ID Indonesian for Indonesia only jp JP Japanese for Japan only no NO Norwegian for Norway only pt BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv SE Swedish for Sweden only th TH Thai for Thailand only tr TR Turkish for Turkey only zh CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh TW Traditional Ch
300. is field is available since version 82 0 SOAP API Developer Reference August 2012 377 a What s New in Version 82 0 New Fields in RefundTransaction Request Field Description MerchantStoreDetails ns MerchantStoreDetailsType Optional Information about the merchant store This field is available since version 82 0 RetryUntil xs dateTime Optional Maximum time until you must retry the refund NOTE This field does not apply to point of sale transactions This field is available since version 82 0 RefundSource ebl RefundSourceCodeType Optional Type of PayPal funding source balance or eCheck that can be used for auto refund It is one of the following values e any The merchant does not have a preference Use any available funding source e default Use the merchant s preferred funding source as configured in the merchant s profile e instant Use the merchant s balance as the funding source e eCheck The merchant prefers using the eCheck funding source If the merchant s PayPal balance can cover the refund amount use the PayPal balance NOTE This field does not apply to point of sale transactions This field is available since version 82 0 RefundType ebl RefundPurposeTypeCodeType Type of refund you are making It is one of the following values e Full Full refund default e Partial Partial refund e ExternalDispute External dispute Value available since version 82 0 e Other
301. itive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN GetExpressCheckoutDetails API Operation Field Description TaxTotal ebl BasicAmountType Optional Sum of tax for all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma OrderDescription xs string Optional Description of items the buyer is purchasing NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 127 single byte alphanumeric characters Custom xs string Optional A free form field for your own use NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not
302. l address the value of Receiver is still your primary email address Character length and limitations 127 single byte alphanumeric characters ReceiverID xs string Unique account ID of the payment recipient the merchant This value is the same as the value of the recipient s referral ID PayerlnfoType Fields Field Description Payer ebl EmailAddressType Email address of buyer Character length and limitations 127 single byte characters PayerID ebl UserIDType Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PayerStatus ebl PayPalUserStatusCodeType Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters PayerName ebl PersonNameType First and last name of buyer PayerCountry ebl CountryCodeType Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PayerBusiness xs string Buyer s business name Character length and limitations 127 single byte characters SOAP API Developer Reference August 2012 171 172 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description Address ns AddressType Buyer s shipping address information PayerName Fields Field Description Salu
303. l lowNote field to 1 in SetExpressCheckout Character length and limitations 255 single byte characters This field is deprecated RedirectRequired xs boolean Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany UserSelectedOptions ebl UserSelectedOptionsType Shipping options and insurance CheckoutStatus ebl CheckoutStatusType Status of the checkout session If payment is completed the transaction identification number of the resulting transaction is returned It is one of the following values e PaymentActionNotInitiated e PaymentActionFailed e PaymentActionInProgress e PaymentCompleted GiftMessage xs string Gift message entered by the buyer on the PayPal checkout pages Character length and limitations 150 single byte characters SOAP API Developer Reference August 2012 115 116 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description GiftReceiptEnable GiftWrapName GiftWrapAmount BuyerMarketingEmail SurveyQuestion SurveyChoiceSelecte d PaymentRequest Info xs string Whether the buyer requested a gift receipt It is one of the following values e true The buyer requested a gift receipt e false The buyer did not request a gift receipt xs string Returns the gift wrap name only if the buyer sel
304. l places the decimal separator must be a period and the optional thousands separator must be a comma OrderDescription xs string Optional Description of items the buyer is purchasing NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 127 single byte alphanumeric characters SOAP API Developer Reference August 2012 97 98 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Custom InvoiceID Not i FyURL ShipToAddress PaymentDetailsItem EnhancedPaymentData NoteText SellerDetails TransactionId AllowedPaymentMethod Type xs string Optional A free form field for your own use NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters xs string Optional Your own invoice or tracking number NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters
305. l recipient of payment to make this refund Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TotalRefundedAmount ebl BasicAmountType Total amount refunded so far from the original purchase Say for example a buyer makes 100 purchase the buyer was refunded 20 a week ago and is refunded 30 in this transaction The gross refund amount is 30 in this transaction The total refunded amount is 50 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is available since version 67 0 RefundInfo ebl RefundInfoType Contains refund payment status information This field is available since version 84 0 MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available
306. l ressOenerade Type e Transactionld 0 1 string e D ul e PaymentAction 0 1 PaymentActionCodeType 2 ene 0 11 md EE PaymentRequestiD 0 1 string El InternationalStateAndCity 0 1 sting E OrderURL 0 1 sting e InternationalStreet 0 1 string El SoftDescriptor D 1 sting e AddressStatus 0 1 AddressStatusCodeType e BranchLevel 0 1 integer E ShippingServiceCodeType e OfferDetails 0 1 OfferDetailsType e Recurring 0 1 RecuringFlagType El PaymentDetaiskem type e Name 0 1 string e Number 0 1 string e Quantity 0 1 integer e Tax 0 1 e Amount 0 1 e EbayltemPaymentDetailsltem 0 1 EbayltemPaymentDetailsitemType e PromoCode 0 1 string e ProductCategory 0 1 ProductCategoryType ad Description 0 1 string e Item Weight 0 1 e ItemLength 0 1 e ItemWidth 0 1 e ItemHeight 0 1 e Item URL 0 1 string E EnhanceditemData 0 1 e ItemCategory 0 1 ltemCategoryType SOAP API Developer Reference August 2012 253 254 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation le le e le le e le le le el el el Name Number Quantity Tax Amount EbayItemPaymentDetailsItem PromoCode ProductCategory Description ItemWeight ItemLength TtemWidth TtemHeight TtemURL EnhancedItemData ItemCategory 0 0 0 0 0 0 0 0 0 0
307. l thousands separator is a comma Equivalent to nine characters maximum for USD CreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Type of credit card Is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set the currencyId to GBP In addition you must specify either StartMonth and Start Year or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters CreditCardNumber xs string Credit card number Only the last 4 digits of the credit card number are returned Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type ExpMonth xs int Credit card expiration month Character length and limitations 2 single byte numeric characters including leading Zero August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description ExpYear xs int Credit card expiration year Character length and limitations 4 single byte numeric characters CardOwner ns PayerInfoType Details about the owner of the credit card StartMonth xs int Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary StartYear xs int Year that
308. lName string string El AddressOwnerCodeType string string El AddressstatusCodeType string CountryCodeType string string string string AddressOwnerCodeType string string e InternationalStateAndCity 0 1 string e InternationalStreet e AddressStatus string AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation GetRecurringPaymentsProfileDetails Response Fields Field Description ProfileID ProfileStatus Description xs string Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response ns RecurringPaymentsProfileStatusType Status of the recurring payment profile It is one of the following values e Active e Pending e Cancelled e Suspended e Expired xs string Description of the recurring payment Character length and limitations 127 single byte alphanumeric characters SOAP API Developer Reference August 2012 209 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description AutoBillOutstanding Amount MaxFailedPayments RecurringPayments ProfileDetails CurrentRecurring PaymentsPeriod RecurringPayments Summary AggregateAmount AggregateOptionalAm ount FinalPaymentDueDate CreditCard ns AutoBillType Indicates whether you would like PayPal to automatically bill th
309. ld Shipping Address Code Empty Postal Code is required 10731 Shipping Address Country The field Shipping Address Empty Country is required 10736 Shipping Address Invalid A match of the Shipping City State Postal Code Address City State and Postal Code failed 11001 Exceeds maximum length Value of NoteText element is truncated 11610 Payment Pending your Payment Pending your review review in Fraud in Fraud Management Filters Management Filters 11611 Transaction blocked by Transaction blocked by your your settings in FMF settings in FMF 11612 Could not process your Could not process your request request to accept deny the to accept deny the transaction transaction 11820 Transaction refused Invalid Order URL because of an invalid argument See additional error messages for details Invalid shipping amount Invalid shipping amount it should equal the shipping amount of the selected shipping option Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option 11821 Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option type 11826 Invalid shipping total Invalid shipping total it should equal the shipping amount of the selected shipping option August 2012 SOAP API Developer Reference API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 12125 P
310. lphanumeric characters ebl EmailAddressType Optional Search by the receiver s email address If the merchant account has only one email address this is the primary email It can also be a non primary email address xs string Optional Search by the PayPal Account Optional receipt ID This field is not applicable to point of sale transactions ebl TransactionID Optional Search by the transaction ID The returned results are from the merchant s transaction records Character length and limitations 19 single byte characters maximum xs string Optional Search by invoice identification key as set by you for the original transaction This field searches the records for items the merchant sells Character length and limitations 127 single byte characters maximum with no wildcards allowed xs string Optional Search by credit card number as set by you for the original transaction This field searches the records for items the merchant sells The field is not applicable to point of sale NOTE No wildcards are allowed Character length and limitations Must be at least 11 and no more than 25 single byte numeric characters maximum Special punctuation such as dashes or spaces is ignored ebl PersonNameType Optional Search by the buyer s name 282 August 2012 SOAP API Developer Reference TransactionSearch API Operation Lm TransactionSearch Request Message Field Description AuctionItemNumbe
311. m with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid SOAP API Developer Reference August 2012 299 300 API Error Codes DirectPayment API Errors Error Code Short Message Long Message
312. mail address provided by the buyer processed Please enter a valid is in an invalid format email address 10544 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 10545 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed because of possible fraudulent activity Contact PayPal for more information 10546 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed because of possible fraudulent activity on the IP address Contact PayPal for more information 10547 Internal Error This transaction cannot be None This is a PayPal internal error processed August 2012 SOAP API Developer Reference API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10548 10549 10550 10552 10553 10554 10555 10556 10561 10562 10563 Invalid Configuration Invalid Configuration Invalid Configuration Invalid Configuration Gateway Decline Filter Decline Filter Decline Filter Decline Invalid Data Invalid Data Invalid Data This transaction cannot be processed The merchant s account is not able to process transactions This transaction cannot be processed The merchan s account is not able to process transactions This transaction cannot be processed This transaction cann
313. mation about funds that are being held and the seller s encrypted account number Updated for 69 0 Added more digital goods support to the CreateRecurringPaymentsProfile and DoReferenceTransaction APIs to enable the merchant to obtain the best rates for digital goods Updated for 66 0 Describes changes to the ExpressCheckout API for implementing Digital Goods Updated for 64 4 including addition of ProtectionEligibilityType field SOAP API Developer Reference August 2012 387 388 Date Description 11 May 2010 Updated for 63 0 Added new NVP API fields to use in version 63 0 Express Checkout integrations Deprecated old fields Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation Added ReverseTransaction API 10 March 2010 Updated information for 62 0 Describes Express Checkout fields recommended 21 January 2010 7 October 2009 16 June 2009 22 May 2009 08 April 2009 26 Nov 2008 23 Sept 2008 3 Sept 2008 June 2008 April 2008 February 2008 January 2008 September 2007 August 2007 to be used in applications that enable implementing parallel payments for a marketplace Updated information for 61 0 Added Express Checkout fields enabling you to provide gift and insurance options to the PayPal checkout pages Updated information for 60 0 updated currency table with new currencies and added Express Checkout API fields fo
314. maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 PaymentPeriod Total xs int BillingCycles Optional Number of billing cycles for payment period e For the regular payment period if no value is specified or the value is O the regular payment period continues until the profile is canceled or deactivated e Forthe regular payment period if the value is greater than 0 the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles PaymentPeriod Amoun cc BasicAmountType t Required Billing amount for each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 195 196 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TrialPeriod Billing Period TrialPeriod Billing
315. ments and recurring payments profiles To associate a recurring payments profile with its billing agreement you must ensure that the description in the recurring payments profile matches the description of a billing agreement For version 54 0 and later use SetExpressCheckout to initiate creation of a billing agreement CreateRecurringPaymentsProfile Request Message i AbstractRequestType I CreateRecurringPaymentsProfileRequestDetailsType Detaillevel 0 DetailLevelCodeType e Token 0 1 string e ErrorLanguage 0 1 string e CreditCard 0 1 CreditCardDetailsType e version string RecurringPaymentsProfileDetails 1 1 RecurringPaymentsProfileDetailsType FE any 0 1 e ScheduleDetails 1 1 ScheduleDetailsType E CreateRecurringPaymentsProfileRequestType se JE CreateRecurringPaymentsProfileRequestDetals CreateRecurringPaymentsProfileRequestDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 187 12 188 e Token o e CreditCard o e RecurringPaymentsProfileDetails 1 e ScheduleDetails 1 PaymentDetailsItem o NOTE string CreditCardDetailsType RecurringPaymentsProfileDetailsType ScheduleDetailsType PaymentDetailsItemType documentation August 2012 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile
316. mestamp 0 1 dateTime Amount BasicAmountType el Ack AckCodeType e TransactionID TransactionId el CorrelationID 0 1 string gt Errors 0 ErrorType gt Version string e Build string pr fe any E DoNonReferencedCreditResponseType Af DoNonReferencedCreditResponseDetails DoNonReferencedCreditResponseDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation DoNonReferencedCreditResponseDetailsType te BasicAmountType a currencyID CurrencyCodeType Amount BasicAmountType e TransactionID TransactionId EI Transactionld NOTE Not all fields shown are available for use Use only the fields described in the documentation DoNonReferencedCredit Response Fields Field Description TransactionID ns TransactionId Unique identifier of a transaction Character length and limitations 17 single byte alphanumeric characters Amount ns BasicAmountType Total of order including shipping handling and tax Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma 78 August 2012 SOAP API Developer Reference ExpressCheckout API Operations Express Checkout API operations include SetExpressCheckout GetExpressCheckoutDetails and DoExpressCheckoutPayment
317. n It is one of the following values e true The buyer chose the default shipping option e false The buyer did not choose the default shipping option Character length and limitations true or false ebl BasicAmountType The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN GetExpressCheckoutDetails API Operation Field Description ShippingOpt ionName xs string The name of the shipping option such as air or ground SellerDetailsType Fields Field Description PayPalAccountID xs string Unique identifier for the merchant For parallel payments this field contains either the Payer Id or the email address of the merchant Character length and limitations 127 single byte alphanumeric characters PaymentRequestinfoType Fields Field Description TransactionId xs string Transaction ID for up to 10 parallel payment requests This field is available since version 64 0 PaymentRequestID xs string Payment request ID for up to 10 payment requests This field is available since version 64 0 PaymentError ns ErrorType Errors associated with the bucket of parallel payment reque
318. n field that is not supported 10512 Invalid Data This transaction cannot be The first name of the buyer is required processed Please enter a first for this merchant name 10513 Invalid Data This transaction cannot be The last name of the buyer is required processed Please enter a last for this merchant name 10519 Invalid Data Please enter a credit card The credit card field was blank 10520 Invalid Data This transaction cannot be The total amount and item amounts do processed not match 10521 Invalid Data This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card 10523 Internal Error This transaction cannot be None This is a PayPal internal error processed 10525 Invalid Data This transaction cannot be The merchant entered an amount of zero processed The amount to be charged is zero 10526 Invalid Data This transaction cannot be The currency code entered is not processed The currency is not supported supported at this time 10527 Invalid Data This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card number and type 10534 Gateway Decline This transaction cannot be The credit card entered is currently processed Please enter a valid credit card number and type restricted by PayPal Contact PayPal for more information SOAP API Developer Reference August 2012 293 294 API Error Codes DirectPayment API Er
319. n the current number of failed payments for this profile Character length and limitations Number string representing an integer xs dateTime Optional The date when billing for this profile begins NOTE The profile may take up to 24 hours for activation Character length and limitations Must be a valid date in UTC GMT format ns BillingPeriodDetailsType Optional The trial period for this schedule ns BillingPeriodDetailsType Optional The regular payment period for this schedule ns CreditCardDetailsType Optional Credit card information for this profile if applicable Credit card billing address is optional but if you update any of the address fields you must enter all of them For example if you want to update the street address you must specify all of the address fields listed in CreditCardDetailsType not just the field for the street address NOTE Only enter credit card details for recurring payments with direct payments AddressType Shipping Fields Field Description Name Streetl Street2 CityName xs string Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters xs string First street address It is required if using a shipping address Character length and limitations 100 single byte characters xs string Optional Second street address Character length and limitations
320. nId xs string Optional Your buyer session identification token NOTE PayPal records this optional session identification token as an additional means to detect possible fraud Character length and limitations 64 single byte numeric characters ReturnFMFDetails xs boolean Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details 256 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReferenceTransaction API Operation Field Description SoftDescriptor xs string Optional Per transaction description of the payment that is passed to the consumer s credit card statement If the API request provides a value for the soft descriptor field the full descriptor displayed on the buyer s statement has the following format lt PP PAYPAL gt lt Merchant descriptor as set in the Payment Receiving Preferences gt lt 1 space gt lt soft descriptor gt The soft descriptor can contain only the following characters e Alphanumeric characters e dash e asterisk e period e space 66 99 If you use any other characters such as PayPal returns an error code The soft descriptor does not include the phone number which can be toggled between the merchant s c
321. nNameType e StartMonth 0 1 int e PayerCountry 0 1 CountryCodeType StartYear 0 1 int e PayerBusiness 0 string IssueNumber 0 1 string e Address 0 1 AddressType E ThreeDSecureRequest 0 1 ThreeDSecureRequestType e ContactPhone 0 1 string e Eci3ds e Cavv xid e Mpivendor3ds 0 e AuthStatus3ds 0 ul string string string string string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 223 224 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation E PayerInfoType e Payer 0 1 EmailaddressType e PayerID 0 1 UserIDType e PayerStatus 0 1 PayPalUserStatusCodeType e PayerCountry 0 1 CountryCodeType e PayerBusiness 0 1 string e Address 0 1 AddressType 0 PayerName PersonNameType ContactPhone string E EmailAddressType E UserIDType E PayPalUserStatusCodeType NameType e MiddleName 0 e LastName O e Suffix 0 NameType NameType SuffixType E CountryCodeType e Name e Street1 e Street2 e CityName e StateOrProvince HF Country HF CountryName e Phone e PostalCode e AddressID e AddressOwner e External ddressID InternationalName InternationalStateAndCity
322. nal Description of items the buyer is purchasing NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 127 single byte alphanumeric characters August 2012 SOAP API Developer Reference DoDirectPayment API Operation am DoDirectPayment Request Message Field Description Custom xs string Optional A free form field for your own use NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters InvoiceID xs string Optional Your own invoice or tracking number NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 256 single byte alphanumeric characters ButtonSource xs string Optional An identification code for use by third party applications to identify transactions Character length and limitations 32 single byte alphanumeric characters Not i fyURL xs string Optional Your URL for receiving Instant Payment Notification IPN about this transaction
323. name email address and country of residence PayerlnfoType Fields Field Description Payer ebl EmailAddressType Email address of buyer Character length and limitations 127 single byte characters PayerID ebl UserIDType Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PayerStatus ebl PayPalUserStatusCodeType Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters PayerName ebl PersonNameType First and last name of buyer SOAP API Developer Reference August 2012 249 250 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description PayerCountry ebl CountryCodeType Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PayerBusiness xs string Buyer s business name Character length and limitations 127 single byte characters Address ns AddressType Buyer s shipping address information PayerNameType Fields Field Description Salutation FirstName MiddleName LastName Suffix xs string Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Buyer s first name Character length and limitations 25 single byte characters
324. nc AddressID 0 1 strinc AddressOwner 0 1 AddressOwnerCcdeType e External ddressID 0 1 strinc nternationzlName 0 1 strinc nternationalstateAndCty 0 1 string E cnternationalstreet 0 1 string E AddressStahis n 1 ArdrassstatisCadeTyne E ShippingServiceCodeTyre E PaymentDetaileItemType Mame 0 1 sting Number 0 1 sting Quantity 0 1 integer Tax 0 1 BasicamountType Amount 0 1 BasicAmountType PromoCode 0 1 sting ProductCategory 0 1 ProductlategaryTyae Descristion 0 1 sting temWeight 0 1 MeasureType temLength 0 1 MeasureType temWidth 0 1 MeasureType ZLenniHziul iL 0 1 MeasureType TtemLRL 0 1 sting EnhancedItemData 0 1 EnhanceditemData ype temCategory 0 1 ItemCategoryType E llowedPaymentMethodType s EnhancedPaymentDataType 8 s s 8 s S S 9 8 S S 9 8 AAA e EbayPaymentDetails 0 1 EbayPaymentDetailsTy2e E ReturnUATFDetails 0 1 string SE Airlineltinerary 0 1 AirlineItineraryType SellerDetailsType le SellerId D 1 string SelleruserName 2 1 string so e SellerRegistrationDate D 1 dateTime e PayPaAccountID D 1 string e SecureMerchantAccountID 3 1 User DTyp2 OfferDetails ype 10 1 string otterCode E BMLOfferInfo 0 1 BMLOfferInfoType EbayltemPaymentDetailsltem 0 1 EbayltemPaymentDetails
325. nd the optional thousands separator must be a comma ShippingTotal ebl BasicAmountType Optional Total shipping costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 61 62 DoDirectPayment API Operation DoDirectPayment Request Message Field Description InsuranceTotal ShippingDiscount HandlingTotal TaxTotal OrderDescription ebl BasicAmountType Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if you offer insurance options NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma InsuranceTotal is available since version 53 0 ebl BasicAmountType Optional Shipping discount for this
326. ng F any 0 1 GetTransactionDetailsRequestType e TransactionID TransactionId NOTE Not all fields shown are available for use Use only the fields described in the documentation GetTransactionDetails Request Fields Field Description TransactionID xs string Required Unique identifier of a transaction NOTE The details for some kinds of transactions cannot be retrieved with GetTransactionDetails You cannot obtain details of bank transfer withdrawals for example Character length and limitations 17 single byte alphanumeric characters SOAP API Developer Reference August 2012 161 a GetTransactionDetails API Operation GetTransactionDetails Response Message GetTransactionDetails Response Message NOTE All fields defined in the formal structure of GetTransactionDetailsResponse are not necessarily returned Data are returned in a response only if PayPal has recorded data that corresponds to the field te AbstractResponseType fe PaymentTransactionType el Timestamp 0 1 dateTime e ReceiverInfo ReceiverInfoType Ack AckCodeType el PayerInfo PayerInfoType e CorrelationID 0 1 string PaymentInfo PaymentInfoType Errors 0 ErrorType PaymentItemInfo 0 1 PaymentItemInfoType Version string Build string fe ThreeDSecureInfoType FE any e ThreeDSecureRequest 0 1 ThreeDSecureRequestType e ThreeDSecureResponse 0 1 ThreeDSecureResponseType
327. ns Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma InsuranceTotal is available since version 53 0 ebl BasicAmountType Optional Shipping discount for this order specified as a negative number NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingDiscount is available since version 53 0 xs boolean Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal pages Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No ebl BasicAmountType Optional Total handling costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a pos
328. nsaction could not be loaded The transaction could not be loaded The masspay receiver_type is not a recognizable type The user account is locked The number of input records is greater than maximum allowed The number of input records is less than or equal to zero The note string length exceeds the maximum limit of 4000 characters The amount is missing The currency is missing Currency is not supported 336 August 2012 SOAP API Developer Reference API Error Codes MassPay API Errors Error Code Short Message Long Message 10004 10004 10004 10004 10004 10004 10007 10301 10303 10304 10305 10306 10307 10308 10309 10310 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Permission denied User not allowed Restricted account Unconfirmed email Limit Exceeded Limit Exceeded Receive only account Masspay server configuration error Massp
329. nsaction refused because of an invalid argument See additional error messages for details PaymentAction of Order is temporarily unavailable Please try later or use other PaymentAction Order total is missing SOAP API Developer Reference August 2012 291 292 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10418 Transaction refused The currencies of the shopping because of an invalid cart amounts must be the same argument See additional error messages for details 10426 Transaction refused Item total is invalid because of an invalid argument See additional error messages for details 10427 Transaction refused Shipping total is invalid because of an invalid argument See additional error messages for details 10428 Transaction refused Handling total is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total 1s invalid because of an invalid argument See additional error messages for details 10432 Invalid argument Invoice ID value exceeds maximum allowable length 10485 Payment not authorized Payment has not been authorized by the user 10500 Invalid Configuration This transaction cannot be Occurs when you have not agreed to the processed due to an invalid billing agreement merchant configuration 10501 Invalid Configuration This transaction cannot be Occurs when the billing agreement is
330. nt API Operation Field Description InstrumentDetails ns InstrumentDetailsType Promotional instrument information This field is introduced in API version 71 0 OfferDetails ns OfferDetailsType Specific information for an offer This field is introduced in API version 71 0 UserSelectedOptions Fields Field Description ShippingCalculationM xs string ode InsuranceOptionSelec ted ShippingOptionIsDefa ult ShippingOpt ionAmount ShippingOpt ionName Describes how the options that were presented to the buyer were determined It is one of the following values e API Callback e API Flatrate xs boolean The option that the buyer chose for insurance It is one of the following values e Yes The buyer opted for insurance e No The buyer did not opt for insurance xs boolean Indicates whether the buyer chose the default shipping option Itis one of the following values e true The buyer chose the default shipping option e false The buyer did not choose the default shipping option Character length and limitations true or false ebl BasicAmount Type The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs string The name of the shipping o
331. nt is pending because it is part of an order that has been authorized but not settled paymentreview The payment is pending while it is being reviewed by PayPal for risk unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if PaymentStatus is Pending ebl ReasonCodeType The reason for a reversal if the transaction type is reversal It is one of the following values e none No reason code e chargeback A reversal has occurred on this transaction due to a chargeback by your buyer e guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee e buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer e refund reversal has occurred on this transaction because you have given the buyer a refund e other A reversal has occurred on this transaction due to a reason not listed above August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations Fe DoReferenceTransaction API Operation
332. nt s default locale It is one of the following locales e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 character codes are also supported for languages in specific countries da DK Danish for Denmark only he IL Hebrew all id ID Indonesian for Indonesia only jp JP Japanese for Japan only no NO Norwegian for Norway only pt BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv SE Swedish for Sweden only th TH Thai for Thailand only tr TR Turkish for Turkey only zh CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh_TW Traditional Chinese for Taiwan only Character length and limitations 2 single byte characters SOAP API Developer Reference August 2012 159 EG GetPalDetails API Operation GetPalDetails Response Message 160 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation The GetTransactionDetails API operation obtains information about a specific transaction GetTransactionDetails Request Message te AbstractRequestType i Transactionld Detaillevel 0 DetaillevelCodeType ErrorLanguage 0 1 string e Version stri
333. ntDetailsItemType 0 1 BasicAmountType e ItemNumber 0 1 string 0 1 BasicAmountType e AuctionTransactionId 0 1 string EbayItemPaymentDetailsItemType e OrderId 0 1 string string CartID 0 1 string ProductCategoryType 0 1 MeasureType 0 1 MeasureType MeasureType 0 1 MeasureType unit token 0 1 MeasureType 0 1 string EnhancedItemDataType 0 1 EnhancedItemDataType E ItemCategoryType ItemCategoryType NOTE Not all fields shown are available for use Use only the fields described in the documentation E PaymentRequestInfo Type ErrorType a e TransactionId 0 1 string e ShortMessage string sse e PaymentRequestID 0 1 string e LongMessage 0 1 string E PaymentError 0 1 ErrorType ses e ErrorCode token e SeverityCode SeverityCodeType e ErrorParameters 0 ErrorParameterType NOTE Not all fields shown are available for use Use only the fields described in the documentation GetExpressCheckoutDetails Response Fields Field Description Token PayerInfo Custom InvoiceID xs string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters ebl PayerInfoType Information about the payer xs string A free form field for your own use as set by you in the Cus
334. ntents Chapter 3 Authorization and Capture API Operation Reference 31 DoCapture API Operation o oo 31 DoCapture Request Message vr rv rar arr arr knr 31 DoCapture Response Message 2 arv aa 34 DoAuthorization API Operation 22e 40 DoAuthorization Request Message Lav llle 40 DoAuthorization Response Message 22 arr vr llle 41 DoReauthorization API Operation a 44 DoReauthorization Request Message llle 44 DoReauthorization Response Message 2 av vr aaa 45 DoVoid API Operation krakk ren 48 DoVoid Request Message aaa 48 DoVoid Response Message 2222s 49 Chapter 4 DoDirectPayment API Operation 51 DoDirectPayment Request Message o eee eee 51 DoDirectPayment Request Fields o e e e 56 CreditCardDetails Type Fields o e 2 58 PayerlntoType Fields lll 59 PayerNameType Fields lll 60 AddressType Fields 22h 60 PaymentDetailsType Fields llle 61 PaymentDetailsltemType Fields llle 64 EbayltemPaymentDetailsltemType Fields vr a 65 AddressType Shipping Fields ln 65 ThreeDSecureRequest Fields U K Merchants Only 66 DoDirectPayment Response Message kake 67 DoDirectPayment Response Fields o krakk ran 68 FMFDeta
335. ntsProfile response fields 232 pdateRecurringPaymentsProfile response message 232 USD 370 serName response field 181 serSelectedOptions request field 129 serSelectedOptions response field 115 serSelectedOptions response fields 124 151 E aaadad u U u V Visa AVS response codes 371 Visa CV V2 response codes 373 VPAS response field 70 W WSDL XSD schema definitions 16 X XID request field 66 Y Yen 369 370 August 2012 399 400 Index Z Zip request field 28 ZipMatch response field 29 Zloty 369 370 August 2012 SOAP API Developer Reference
336. o be charged to the buyer for gift wrapping NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 93 o ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BuyerEmailOptinEnab le SurveyQuestion SurveyEnable SurveyChoice TotalType NoteToBuyer PaymentReason xs string Optional Enables the buyer to provide their email address on the PayPal pages to be notified of promotions or special events Is one of the following values e 0 Do not enable buyer to provide email address e 1 Enable the buyer to provide email address xs string Optional Text for the survey question on the PayPal pages If the survey question is present at least 2 survey answer options must be present Character length and limitations 50 single byte characters xs string Optional Enables survey functionality It is one of the following values e 0 Disables survey functionality e 1 Enables survey functionality xs string Optional Possible options for the survey answers on the PayPal pages Ans
337. od 10618 Transaction Transaction has already DoAuthorization Close the order or already voided been voided or expired DoCapture authorization or expired DoReauthorization DoVoid 10619 Invoice ID value Invoice ID value exceeds DoCapture Check the length of the exceeds maximum allowable invoice ID and reattempt maximum length the request allowable length 10620 Order has Order has already been DoAuthorization Close this order already been voided expired or DoCapture voided expired completed Do Void or completed 10621 Order has Order has expired DoAuthorization Close this order expired DoCapture DoVoid 10622 Order is voided Order is voided DoAuthorization Close this order DoCapture DoVoid 10623 Maximum Maximum number of DoAuthorization Capture this order number of authorization allowed for DoCapture Hero the order is reached DoReauthorization allowed for the order is reached Doluid 10624 Duplicate Payment has already DoAuthorization Review the invoice ID invoice been made for this and reattempt the request Invoice ID SOAP API Developer Reference August 2012 329 330 API Error Codes Authorization and Capture API Errors Error Short Returned By API Correcting This Code Message Long Message Call Error 10625 Transaction The amount exceeds the DoAuthorization Reattempt the request refused because maximum amount for a DoCapture with a lower amount of an invalid single transaction DoReauth
338. odeType Name 0 1 string Street1 0 1 string Street2 0 1 string CityName 0 1 string StateOrProvince 0 1 string El Country 0 CountryCodeType amp CountryName 0 1 string e Phone 0 1 string PostalCode 0 1 string e AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType e ExternalAddressID 0 1 string e InternationalName 0 1 string e InternationalStateAndcity 0 1 string e InternationalStreet 0 1 string e AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Only use fields described in the documentation GetBillingAgreementCustomerDetails Response Fields Field Description PayerInfo ns PayerInfoType Information about the buyer such as the buyer s name email address and country of residence August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 GetBillingAgreementCustomerDetails API Operation PayerlnfoType Fields Field Description Payer ebl EmailAddressType Email address of buyer Character length and limitations 127 single byte characters PayerID ebl UserIDType Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PayerStatus ebl PayPalUserStatusCodeType Status of buyer It is one of the following values e verified e unverified Charact
339. omerDetails and CreateRecurringPaymentsProfile February 2007 Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs changing some parameters to optional in DoDirectPayment adding SHIPTOCOUNTRYCODE and adding Switch Solo codes for AVS and CVV2 December 2006 Updates for bug fixes October 2006 First public release 11 May 2010 Added new NVP API fields to use in version 63 0 Express Checkout integrations Deprecated old fields Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation Added ReverseTransaction API SOAP API Developer Reference August 2012 389 390 August 2012 SOAP API Developer Reference Index A AcceptFilters response field 68 152 273 Action request field 183 217 ActivationDetails request field 194 ActivationDetailsType request fields 197 AdditionalBilling Cycles request field 225 Address Owner response field 172 215 Address request field 59 77 88 200 231 Address response field 117 172 215 243 250 AddressOverride request field 89 AddressStatus response field 118 172 211 216 244 AddressType Shipping request fields 65 95 130 198 227 258 AddressType Shipping response fields 118 AddressType request fields 60 77 201 231 AddressType response fields 172 211 215 244 Address Verify API operation 27 Address Verify request fields 27 Address Verify request message 27
340. ompleted 1 1 int NumberCyclesRemaining 1 1 int OutstandingBalance FailedPaymentCount LastPaymentDate LastPaymentAmount CreditCardType CreditCardNumber ExpMonth ExpYear CardOwner Cw2 StartMonth StartYear IssueNumber ThreeDSecureRequest 0 1 ThreeDSecureRequestType 1 1 BasicAmountType 1 1 int 0 1 dateTime 0 1 BasicAmountType 0 1 CreditCardTypeType 0 1 string 0 1 int 0 1 int 0 1 PayerInfoType 0 1 string 0 1 int 0 1 int 0 1 string BasicAmountType 8 currencyID CurrencyCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation E AddressType e Name 0 1 string Street1 0 1 string Street2 0 1 string e CityName 0 1 string StateOrProvince 0 1 string amp Country 0 1 CountryCodeType amp CountryName 0 1 string e Phone 0 1 string PostalCode 0 1 string e AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType e ExternalAddressID 0 1 string SubscriberName 0 1 string e SubscriberShippingAddress 0 1 AddressType e BilingStartDate 1 1 dateTime ProfileReference 0 1 string InternationalName 0 1 string
341. on and Capture API operations describe the PayPal API operations related to delayed payment settlement DoCapture API Operation Captures an authorized payment DoCapture Request Message ze AbstractRequestType DetailL evel 0 DetailLevelCodeType i EN e BasicAmountType 8 currencylD CurrencyCodeType i CompleteCodeType t EnhancedDataType e Airlineltinerary 0 1 AirlineltineraryType e ErrorLanguage 0 1 string e Version string F any 0 1 DoCaptureRequestType e AuthorizationID 1 1 Authorizationid Amount 1 1 BasicAmountType H MerchantStoreDetailsType e CompleteType 1 1 CompleteCodeType e StorelD 1 1 string E Note 0 1 string fe TerminallD 0 1 string ses e InvoicelD 0 1 string EnhancedData 0 1 EnhancedDataType e Descriptor 0 1 string HE MerchantStoreDetails 0 1 MerchantStoreDetailsType e MsgSubID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 31 32 Authorization and Capture API Operation Reference DoCapture API Operation DoCapture Request Fields Field Description AuthorizationID Amount CompleteType InvoiceID Note xs string Required Authorization identification number of the payment you want to capture This is the transaction ID returned from DoExpressCheckout Payment
342. on occurs in the buyer s account Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Decimal value that does not exceed 17 characters including decimal point August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description PaymentStatus ebl PaymentStatusCodeType The status of the payment It is one of the following values The status of the payment You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e None No status e Canceled Reversal A reversal has been canceled for example when you win a dispute and the funds for the reversal have been returned to you e Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired the authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from you
343. onCode element specifies the reason for the reversal e Processed A payment has been accepted e Voided An authorization for this transaction has been voided 46 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoReauthorization API Operation Field Description PendingReason ebl PendingStatusCodeType Reason the payment is pending It is one of the following values e none No pending reason e address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile e authorization The payment is pending because it has been authorized but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview e multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment e order The payment is pending because it is part of an order that has been authorized
344. onal elements are as follows e ShortMessage e LongMessage e ErrorCode Additional information can appear as part of ErrorParametersType For example if the error in ParamID is ProcessorResponse the Value would contain the processor specific error such as 0091 Values set in the ErrorParametersType are not set by PayPal rather they are passed through from the source NOTE PayPal only passes selected values in ErrorParametersType The following example shows the error response if your API username and password do not match a legitimate API username and password on file with PayPal Example of SOAP Error Response Bad Username or Password lt xml version 1 0 encoding UTF 8 gt lt SOAP ENV Envelope details not shown gt S OAP ENV Header gt details not shown lt SOAP ENV Header SOAP ENV Body id 0 gt lt GetTransactionDetailsResponse xmlns urn ebay api PayPalAPI gt lt Timestamp xmlns urn ebay apis eBLBaseComponents gt 2005 02 09T21 51 262 lt Timestamp gt lt Ack xmlns urn ebay apis eBLBaseComponents gt Failure lt Ack gt lt Errors xmlns urn ebay apis eBLBaseComponents xsi type ebl ErrorType gt lt ShortMessage xsi type xs string gt Authentication Authorization Failed lt ShortMessage gt lt LongMessage xsi type xs string gt Username Password is incorrect lt LongMessage gt lt ErrorCode xsi type xs token gt 10002 lt ErrorCode gt lt SeverityCode xmlns urn ebay apis eB
345. one of the following values e cart e express checkout Character length and limitations 15 single byte characters 36 August 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference EN DoCapture API Operation Field Description PaymentType ebl PaymentCodeType Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters PaymentDate xs dateTime Time date stamp of payment For example 2006 08 15T17 23 15Z GrossAmount ebl BasicAmount Type The final amount charged including any shipping and taxes from your Merchant Profile Shipping and taxes do not apply to point of sale transactions Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD FeeAmount ebl BasicAmountType PayPal fee amount charged for the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for
346. onst 2 single byte characters PostalCode xs string Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters Phone xs string Optional Phone number Character length and limitations 20 single byte characters SOAP API Developer Reference August 2012 231 232 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile Response Message 1 AbstractResponseType o Timestamp 0 1 dateTime Ack AckCodeType o CorrelationID 0 1 string e Errors 0 ErrorType Version string Build string FE any 0 1 E UpdateRecurringPaymentsProfileResponseType i UpdateRecurringPaymentsProfileResponseDetailsType E UpdateRecurringPaymentsProfileResponseDetails UpdateRecurringPaymentsProfileResponseDetailsType e ProfileID 1 1 string NOTE Not all fields shown are available for use Use only the fields described in the UpdateRecurringPaymentsProfile Response Fields documentation Field ProfileID Description xs string Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired August 2012 SOAP API Developer Reference Recurring Payments an
347. operation processes a payment from a buyer s account which is identified by a previous transaction DoReferenceTransaction Request Message DoReferenceTransactionRequestDetailsType DetailLevel 0 DetailLevelCodeType ReferencelD 1 1 string ErrorLanguage 0 1 string e PaymentAction 1 1 PaymentActionCodeType Version string PaymentType 0 1 MerchantPullPaymentCodeType F any 0 1 Le PaymentDetails 1 1 PaymentDetailsType CreditCard 0 1 ReferenceCreditCardDetailsType e IPAddress 0 1 string MerchantSessionld 0 1 string E DoReferenceTransactionRequestType ReqConfirmShipping 0 1 string JB DoReferenceTransactionRequestDetails 1 1 DoReferenceTransactionRequestDetailsType E SoftDescriptor 0 1 string e ReturnFMFDetails 0 1 int SenderDetails 0 1 SenderDetailsType el MsgSubID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 251 12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation E DoReferenceTransactionRequestDetails Type E PaymentActionCodeType e ReferencelD 1 1 string e PaymentAction 1 1 PaymentActionCodeType E MerchantPullPaymentCodeType e PaymentType 0 1 MerchantPullPaymentCodeType e PaymentDetails 1 1 PaymentDetail
348. or must be a comma ShippingAmount cc BasicAmountType Optional Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TaxAmount cc BasicAmountType Optional Tax amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set currencyId to GBP In addition you must specify either Scart Month and StartYear or IssueNumber Characte
349. or must be a period and the optional thousands separator must be a comma xs string The gift message the buyer entered on the PayPal pages Limitations 100 single byte characters xs string Indicates whether a gift receipt widget is enabled on the PayPal pages It is one of the following values e 0 Do not enable gift receipt widget e 1 Enable gift receipt widget xs string Label for the gift wrap option such as Blue box with ribbon Limitations 25 single byte characters SOAP API Developer Reference August 2012 169 pg GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description GiftWrapAmount BuyerMarketingEmail SurveyQuestion SurveyChoiceSelecte d ebl BasicAmounttype Amount to be charged to the buyer for the gift wrap Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies ebl EmailAddressType The email address the buyer entered on the PayPal pages to be notified of promotions or special events Limitations 127 single byte characters xs string Text for the survey question on the PayPal pages
350. or set in Payment Receiving Preferences 1 For example assume the following conditions e The PayPal prefix toggle is set to PAYPAL in PayPal s administration tools e The merchant descriptor set in the Payment Receiving Preferences is set to EB AY e The soft descriptor is passed in as JanesFlowerGifts LLC The resulting descriptor string on the credit card is PAYPAL EBAY JanesFlow MerchantStoreDetail ns MerchantStoreDetailsType S Optional Information about the merchant store This field is available since version 82 0 MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 SOAP API Developer Reference August 2012 33 E Authorization and Capture API Operation Reference DoCapture API Operation MerchantStoreDetailsTypeFields Field Description StoreID xs string Identifier of the merchant store at which the refund is given This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 82 0 TerminalID xs string Optional ID of the terminal Character length
351. order specified as a negative number NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingDiscount is available since version 53 0 ebl BasicAmountType Optional Total handling costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Optional Sum of tax for all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs string Optio
352. orization argument See additional error messages for details 10626 Risk Transaction refused due DoAuthorization Contact the buyer to risk model DoCapture DoReauthorization 10627 Transaction The invoice ID field is DoAuthorization The Invoice ID field can refused because not supported for basic DoReauthorization be used only with of an invalid authorizations DoVoid DoCapture argument See additional error messages for details 10628 This transaction This transaction cannot DoAuthorization Retry the request at a cannot be be processed at this time DoCapture later time processed at this Please try again later DoBaauthadzation time Please t i 1y DoVoid again later 10629 Reauthorization Reauthorization is not DoReauthorization Use DoAuthorization to not allowed allowed for this type of authorize the order authorization 10630 Item amount is Item amount is invalid DoAuthorization Check the item amount to invalid DoCapture ensure that it is not zero or negative 10631 Processor The authorization is DoAuthorization Warning being processed 11094 This This authorization can authorization only be handled through cannot be the marketplace which voided created it It cannot reauthorized or directly be voided capturedagainst reauthorized or captured against 13122 Transaction Transaction violates DoCapture refused PayPal use August 2012 SOAP API Developer Reference API Error Codes GetTransactionD
353. ot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed There s an error with this transaction Please enter complete billing address This transaction cannot be processed Please enter a valid credit card expiration year This transaction cannot be processed Please enter a valid credit card expiration month The merchant account attempting the transaction is not a business account at PayPal Check your account settings The merchant account attempting the transaction is not able to process Direct Payment transactions Contact PayPal for more information Access to Direct Payment was disabled for your account Contact PayPal for more information The merchant account attempting the transaction does not have a confirmed email address with PayPal Check your account settings The merchant attempted a transaction where the amount exceeded the upper limit for that merchant The transaction was declined because of a merchant risk filter for AVS Specifically the merchant has set to decline transaction when the AVS returned a no match AVS N The transaction was declined because of a merchant risk filter for AVS Specifically the merchant has set the filter to decline transactions when the AVS returns a partial match The transaction was declined because of a merchant risk filter for AVS
354. ource Only instant funding methods are allowed Block echeck meft elevecheck This value overrides any merchant profile settings 102 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN SetExpressCheckout API Operation ShippingOptionsType Fields Field Description ShippingOptionIsDefau xs boolean lt Default shipping optio displayed on the PayPal pages This field is required if you specify the Callback URL It is one of the following values e true This is the default flat rate shipping option PayPal displays this option and its amount by default e false This flat rate shipping option and its amount are not displayed as the default NOTE There must be ONE and ONLY ONE default It is not OK to have no default ShippingOptionName xs string Internal name of the shipping option such as Air Ground Expedited and so forth This field is required if you specify the Callback URL Character length and limitations 50 character string ShippingOptionAmount ebl BasicAmountType Amount of the flat rate shipping option This field is required if you specify the Callback URL Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma BillingAgreementDetailsType Fields Field Des
355. out the buyer s tax information This field is required for Brazil and is for Brazil use only 380 August 2012 SOAP API Developer Reference What s New in Version 72 0 New TaxldDetailsType Structure in SetExpressCheckout Request TaxldDetailsType Fields Field Description TaxIdType TaxId New field xs string The buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR CPF for individuals and BR CNPJ for businesses New field xs string The buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte character for individuals and 14 single byte characters for businesses New TaxldDetailsType Structure in GetExpressCheckoutDetails Response TaxldDetailsType Fields Field Description TaxIdType TaxId New field xs string The buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR CPF for individuals and BR CNBJ for businesses New field xs string The buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte character for individuals and 14 single byte characters for businesses SOAP API Developer Reference August 2012 381 en What s New in Version 69 What s New in Version 69 New PaymentDetailsl
356. pe DoDirectPayment API Operation DoDirectPayment Request Message E Acdress ype Nane Street E Street E CityNeme E StateGrProvince El Country El CountryNarre Phurie PustalCude AddressID el AddressOwner ExtemalAddressID E InternetionalName InternetionalStaleAndCity 2 InternetionalStree 2 AddressSto us El ShippingServiceCodeTyp2 E FaymertNetailslterTyne August 2012 2 Nome Number E Quantity el Tax E Amount wr 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 EbayltemPeymertDetai sitem 2 PrrmrCnde el PreductCategory Description el ler Weight temLength ller Width Itern Height temURL EnhancedltemCaa llemCateqory strinc strinc strinc strinc strinc CountryCodeType strinc string string strinc AddrzssIwne Code Type string string strinc strinc Addrass3totusCode Type 0 1 0 1 0 1 0 1 0 1 0 1 Ebayltem aymentDetailsltemTypa n 1 0 1 ProductCatecoyType LU 1 string 0 1 0 1 0 1 U 1 4 1 string 0 1 0 1 temCateqoryType string string integer string 53 4 DoDirectPayment API Operation DoDirectPayment Request Message O O EI AllowedPaymentMethod Type e Sellerld SellerDetails Type 0 1 string e SellerUserName 0 1 string Sell
357. pe 0 1 ChannelType el Biling greementDetails 0 Biling amp greementDetailsType PromoCodes 0 string el PayPalCheckOutBtnType 0 1 string el ProductCategory 0 1 ProductCategoryType el ShippingMethod 0 1 ShippingServiceCodeType el ProfileAddressChangeDate 0 1 dateTime el AllowNote 0 1 string el FundingSourceDetails 0 1 FundingSourceDetailsType el BrandName 0 1 string el CallbackURL 0 1 string EnhancedCheckoutData 0 1 EnhancedCheckoutDataType el OtherPaymentMethods 0 OtherPaymentMethodDetailsType el BuyerDetails 0 1 BuyerDetailsType PaymentDetails 0 10 PaymentDetailsType el FlatRateShippingOptions 0 ShippingOptionType el CallbackTimeout 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference ExpressCheckout API Operations SetExpressCheckout API Operation el CallbackTimeout 0 1 string e CallbackYersion 0 1 string CustomerServiceNumber 0 1 string GiftMessageEnable 0 1 string el GiftReceiptEnable 0 1 string el GiftWrapEnable 0 1 string el GiftWrapName 0 1 string el GiftWrapAmount 0 1 Basic mountType el BuyerEmailOptInEnable 0 1 string e SurveyEnable 0 1 string SurveyQuestion 0 1 string e SurveyChoice 0 string TotalType 0 1 TotalType NoteToBuyer 0 1 string el Incentives 0
358. pe PaymentCode Type RefundSourceCode Type RefundSourceCode Type ExpectedeCheckClearDate date Time PaymentDate date Time GrossAmount FeeAmount SettleAmount TaxAmount ExchangeRate string PaymentStatus PaymentStatusCodeType PendingReason PendingStatusCodeType ReasonCode ReversalReasonCodeType HoldDecision string ShippingMethod string ProtectionEligibility string ProtectionEligibilityType string ShipAmount string ShipHandleAmount string ShipDiscount string InsuranceAmount string Subject string SellerDetails SellerDetails Type PaymentRequestlD string FMFDetails FMFDetailsType EnhancedPaymentinto PaymentError ErrorType InstrumentDetails InstrumentDetailsType OfferDetails OfferDetailsType le afl e le e e e el e e e e e e e le e le e e le e le ei el el e le le e E NOTE Not all fields shown are available for use Use only the fields described in the documentation DoCapture Response Fields Field Description AuthorizationID xs string Authorization identification number you specified in the request Character length and limits 19 single byte characters maximum Payment Info ebl Payment InfoType Information about the payment SOAP API Developer Reference August 2012 35 NS Authorization and Capture API Operation Reference DoCapture API Operation Field Description MsgSubld xs string Optional A message ID
359. pecified you must specify the estimated value of the order when using a flat rate shipping option Shipping total is missing you must specify a shipping total when using a flat rate shipping option Insurance amount is missing you have offered insurance but have not specified an amount Callback URL is too long it must not exceed 1 024 characters Maximum amount of order is less than itemized amounts the value of all items including handling shipping tax and insurance cannot be greater than the maximum amount of the order Seller blocks payments via eBay checkout for all eBay items Express Checkout not supported for you Buyer ID must be specified to process an Immediate Payment item The item specified is either not valid Please check that the item is a or is not currently available for valid Immediate Payment item purchase as an Immediate Payment item Only one Immediate Payment item can be paid for in a single PayPal payment transaction Requests for eBay Immediate Payment items should not contain either eBay transaction ID or eBay order ID If the fields are present they should contain null values Cart ID is required for Immediate Payment item SOAP API Developer Reference August 2012 315 316 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 12208 eBay item amount does not eBay item amount must match match Expr
360. pecified 1s marked as the default you can only specify one default shipping option at a time 11823 No default shipping option You must specify one shipping specified option type as the default 11824 Invalid callback timeout The callback timeout is zero you must specify a longer timeout value 11825 Flat rate shipping options Flat rate shipping options are are missing missing you must specify flat rate shipping options when you specify a callback URL 11826 Invalid shipping total Invalid shipping total it should equal the shipping amount of the selected shipping option 11827 Line items missing Line items missing line items are required when you specify a callback URL for flat rate shipping options August 2012 SOAP API Developer Reference API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11828 11829 11830 11831 11832 12109 12124 12200 12201 12202 12205 12207 Maximum amount of order not specified Shipping total is missing Insurance amount is missing Callback URL is too long Maximum amount of order is less than itemized amounts Option not supported Option not supported Buyer ID is not present Immediate Payment item was not found More than one eBay item is present eBay Transaction ID and eBay Order ID must be null Cart ID is required for Immediate Payment item Maximum amount of order not s
361. perations 12 CreateBillingAgreement API Operation CreateBillingAgreement API Response Message te AbstractResponseType Timestamp 0 1 dateTime Ack AckCodeType CorrelationID 0 1 string Errors 0 ErrorType Version string Build string any CreateBiling greementResponseType e Biling greementID string NOTE Not all fields shown are available for use Use only the fields described in the documentation CreateBillingAgreement Response Fields Field Description BillingAgreementID xs string Identification number of the billing agreement SOAP API Developer Reference August 2012 239 FE Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation GetBillingAgreementCustomerDetails API Operation The GetBillingAgreementCustomerDetails API operation obtains information about a billing agreement s PayPal account holder GetBillingAgreementCustomerDetails Request Message fe AbstractRequestType ExpressCheckoutTokenType e Detail evel 0 DetaillevelCodeType e Errorlanguage 0 1 string e Version string PE any 0 1 GetBillingAgreementCustomerDetailsRequestType ses e Token ExpressCheckoutTokenType NOTE Not all fields shown are available for use Use only the fields described in the documentation GetBillingAgreementCustomerDetails Request Fields Field Description Token xs string Required
362. positive integer Tax ebl BasicAmountType Optional Item sales tax NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma EbayltemPaymentDetailsltemType Fields Field Description ItemNumber xs string Optional Auction item number Character length 765 single byte characters AuctionTransaction xs string Id Optional Auction transaction identification number Character length 255 single byte characters OrderID xs string Optional Auction order identification number Character length 64 single byte characters 262 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReference Transaction API Operation ReferenceCreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Optional Type of credit card Is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card
363. press Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout session has Token expired session has expired expired Token value is no longer valid SOAP API Developer Reference August 2012 347 348 API Error Codes UpdateBillingAgreement Errors Error Code Short Message Long Message Additional Information 11455 Buyer did not accept billing Buyer did not accept billing Buyer has not agreed to the agreement agreement billing agreement 11456 A successful Billing Transaction refused because of an Token has already been used to Agreement has already invalid argument See additional create a billing agreement been created for this token error messages for details 10408 Missing token Token is missing Token is missing 10409 You re not authorized to Express Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout session has Token expired session has expired expired Token value is no longer valid UpdateBillingAgreement Errors UpdateBilling Agreement Errors Error Code Short Message Long Message Additional Information 10001 Internal Error Internal Error 10004
364. process the payment and redisplay the customer to use an alternative payment methods with alternative payment method which the buyer can pay 10418 Transaction refused The currencies of the shopping because of an invalid cart amounts must be the same argument See additional error messages for details 10419 Express Checkout Express Checkout PayerID is PayerID is missing missing 10420 Transaction refused Express Checkout because of an invalid PaymentAction is missing argument See additional error messages for details 10421 This Express Checkout This Express Checkout session Verify that your programs are properly session belongs to a belongs to a different customer associating the Tokens and PayerTDs different customer Token value mismatch 10422 Customer must choose The customer must return to new funding sources PayPal to select new funding sources 10424 Transaction refused Shipping address is invalid If you receive this error message because of an invalid PayPal recommends that you return argument See additional your buyer to PayPal to review and error messages for details approve new valid funding sources Although this error is rare you should consider trapping the error to display a message to the buyer describing what happened along with a button or hyperlink to return to PayPal 10426 Transaction refused Item total is invalid because of an invalid argument See additional error messages for details 10427 Tr
365. ption such as air or ground PaymentErrorType Fields Field Description ShortMessage xs string Payment error short message SOAP API Developer Reference August 2012 151 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description LongMessage xs string Payment error long message ErrorCode xs string Payment error code SeverityCode xs string Payment error severity code ErrorParameters xs string Application specific error values indicating more about the error condition SellerDetailsType Fields Field Description PayPalAccountID xs string Unique identifier for the merchant For parallel payments this field contains either the Payer Id or the email address of the merchant Character length and limitations 127 single byte alphanumeric characters SecureMerchantAccountID xs useridtype Unique PayPal customer account number of the merchant This field is returned in the response It is ignored if passed in the request FMFDetailsType Fields Field Description AcceptFilters xs RiskFilterListType List of filters that recommend acceptance of the payment DenyFilters xs RiskFilterListType List of filters that recommend denial of the payment PendingFilters xs RiskFilterListType List of filters that caused the payment to become pending ReportsFilters xs RiskFilterListType List of filters that caused the payment to become flagged
366. ption period It is one of the following values e Day e Week e SemiMonth e Month e Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year BillingFrequency xs int Number of billing periods that make up one billing cycle The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 TotalBillingCycles xs int Number of billing cycles for payment period either the regular payment period or the trial period e For the trial period the value must be greater than 0 e For the regular payment period if no value is specified or the value is 0 the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater than 0 the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles 212 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 GetRecurringPaymentsProfileDetails API Operation Field Description Amount cc BasicAmount Type Billing amount fo
367. ptional Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary SOAP API Developer Reference August 2012 75 76 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description StartYear xs int Optional Year that Maestro card was issued Character length and limitations 4 digits IssueNumber xs string Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum PayerNameType Fields Field Description Salutation FirstName MiddleName LastName Suffix xs string Optional Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Optional Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Optional Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Optional Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Optional Buyer s suffix Character length and limitations 12 single byte characters PayerlnfoType Fields Field Description Payer ns EmailAddressType Optional Email address of buyer Character length and limitations 127 single byte characters FirstName ns PersonNameType Required Buyer s first name Character length and limitations 25 single byte characters
368. r s account Character length and limitations Decimal value that does not exceed 17 characters including decimal point August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReference Transaction API Operation Field Description PaymentStatus ebl PaymentStatusCodeType Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has been canceled for example when you win a dispute and the funds for the reversal have been returned to you Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your buyer s bank account In Progress The transaction has not terminated for example an authorization may be awaiting completion Partially Refunded The payment has been partially refunded Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returne
369. r 0 1 string ExpMonth 0 1 int e Payer EmailAddressType e PayerlD 0 1 UserlDType ExpYear 0 1 int CardOwner 0 1 PayerlnfoType PayerStatus 0 1 PayPalUserStatusCodeType CVV 0 1 string StartMonth 0 1 int StartYear 0 1 int PayerName PersonNameType e PayerCountry CountryCodeType e PayerBusiness string Address AddressType IssueNumber 0 1 string ThreeDSecureRequest 0 1 ThreeDSecureRequestType ContactPhone string TaxldDetails TaxldDetails Type nfo questType Eci3ds string Caw string Xid string Mpivendor3ds string AuthStatus3ds string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 55 56 DoDirectPayment API Operation DoDirectPayment Request Message e PayerName e PayerCountry 0 e PayerBusiness 0 e Address 0 e ContactPhone 0 Payer 0 e PayerID 0 e PayerStatus O E Email ddressType 5 UserIDType E PayPalUserStatusCodeType Email ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string PersonNameType AddressType Salutation 0 1 SalutationType e FirstName 0 1 MameType string e MiddleName 0 1 MameType e LastName 0 1 MameType e Suffix 0 1 SuffixType 5 Co
370. r Immediatee Payment and eBay Updated information for 58 0 added GetPalDetails API and fields for payment review Minor update to version 57 0 added CreateBillingAgreement to Enterprise edition Updated information for 57 0 Express Checkout Callback API and error codes Updated information for 55 0 Added information about using billing agreements with SetExpressCheckout Added information about payment review to GetTransactionDetails Rearranged material added error codes and moved some material to the Express Checkout Integration Guide Added Fraud Management Filters information Changed recurring payments information Added that ther VERSION parameter must be 50 0 in the API call to use recurring payments e Added billing agreement fields to SetExpressCheckout for recurring payments Updated CreateRecurringPaymentsProfile for new recurring payments features e Added new recurring payments APIs e Added DoNonReferencedCredit API e Update eBay auctions for Express Checkout section e Added fields for the giropay payment method to Express Checkout APIs e Added Direct Payment error 10571 Added recurring payments concepts modified SetExpressCheckout DoExpressCheckoutPayment DoReferenceTransaction and added additional DoReferenceTransaction error codes August 2012 SOAP API Developer Reference Date Description April 2007 Added Recurring Payments APIs SetCustomerBillingAgreement GetBillingAgreementCust
371. r buyer s bank account e In Progress The transaction has not terminated e g an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returned to the buyer The reason for the reversal is specified in the ReasonCode element e Processed payment has been accepted e Voided An authorization for this transaction has been voided e Completed Funds Held The payment has been completed and the funds have been added successfully to your pending balance See the HoldDeci sion field for more information SOAP API Developer Reference August 2012 147 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PendingReason ebl PendingStatusCodeType Reason the payment is pending It is one of the following values Reason the payment is pending You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none No pending reason e address The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually a
372. r details Long Message Correcting This Error Transaction failed due to internal error Warning an internal error has occurred The transaction id may not be correct The transaction could not be loaded Internal Error Transaction refused because of an invalid argument See additional error messages for details The transaction id is not valid August 2012 SOAP API Developer Reference API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10004 10004 10004 10004 10004 10004 10004 10004 10004 10004 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused b
373. r each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ShippingAmount cc BasicAmount Type Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TaxAmount cc BasicAmount Type Tax amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma RecurringPaymentsSummaryDetailsType Fields Field Description NextBillingDate xs dateTime The next sched
374. r length and limitations Up to 10 single byte alphabetic characters SOAP API Developer Reference August 2012 229 230 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description CreditCardNumber ExpMonth ExpYear CVV2 CardOwner StartMonth StartYear IssueNumber xs string Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type xs int Required Credit card expiration month Character length and limitations 2 single byte numeric characters including leading Zero xs int Required Credit card expiration year Character length and limitations 4 single byte numeric characters xs string Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits ns PayerInfoType Required Details about the owner of the credit card xs int Optional Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary xs int Optional Year tha
375. r xs string Optional Search by auction item number of the purchased goods This field is not applicable to point of sale TransactionClass ePaymentTransactionClassCodeType Optional Search by classification of transaction Some kinds of possible classes of transactions are not searchable with this field You cannot search for bank transfer withdrawals for example It is one of the following values A11 All transaction classifications Sent Only payments sent Received Only payments received MassPay Only mass payments MoneyRequest Only money requests FundsAdded Only funds added to balance FundsWithdrawn Only funds withdrawn from balance Referral Only transactions involving referrals Fee Only transactions involving fees Subscription Only transactions involving subscriptions Dividend Only transactions involving dividends Billpay Only transactions involving BillPay Transactions Refund Only transactions involving funds CurrencyConversions Only transactions involving currency conversions BalanceTransfer Only transactions involving balance transfers Reversal Only transactions involving BillPay reversals Shipping Only transactions involving UPS shipping fees BalanceAffecting Only transactions that affect the account balance ECheck Only transactions involving eCheck Amount ebl BasicAmountType Optional Search by transaction amount NOTE You must set the currencyID a
376. rStatus 0 e PayerName e PayerCountry 0 e PayerBusiness 0 Address 0 e ContactPhone 0 e Eci3ds e Cavv e xid e Mpivendor3ds 0 e AuthStatus3ds 0 Email ddressType UserIDType PayPalUserStatusCodeType PersonNameType CountryCodeType string AddressType string 1 string 1 string ul string 1 string 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation August 2012 SOAP API Developer Reference DoNonReferencedCredit API Operation Ca DoNonReferencedCredit Request Message E PayerInfoType E Email ddressType e Payer 0 1 Email ddressType PayerID 0 1 UserIDType E UserIDType E PayPalUserStatusCodeType e PayerStatus 0 1 PayPalUserStatusCodeType e PayerName PersonNameType e PayerCountry 0 1 CountryCodeType PersonNameType e Salutation 0 1 SalutationType e FirstName 0 1 MameType e PayerBusiness 0 1 string e Address 0 1 AddressType e ContactPhone 1 0 1 string e MiddleName 0 1 MameType e LastName 0 1 MameType e Suffix 0 1 SuffixType E CountryCodeType Name 0 1 string e Street1 0 1 string Street2 0 1 string e CityName 0 1 string StateOrProvince 0 string amp Country 0 1 CountryCodeType Af CountryName 0 1
377. rUserName BuyerRegistrationDa te TaxIdDetails 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 xs string Optional The user name of the user at the marketplaces site 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 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 FundingSourceDetailsType Fields Field Description AllowPushFunding AllowedPaymentMetho d xs string Optional Indicates whether the merchant can accept push funding It is one of the following values e 0 Merchant can accept push funding e 1 Merchant cannot accept push funding NOTE This field overrides the setting in the merchant s PayPal account ns AllowedPaymentMethodType Optional The type of funding sources allowed It is one of the following values e Default Merchant supports all funding sources e InstantOnly Merchant only supports instant payments e AnyFundingSource All funding methods allowed to be chosen by the buyer irrespective of the merchant profile setting InstantFundingS
378. ransaction identification number of the transaction that was created NOTE This field is only returned after a successful transaction for DoExpressCheckout has occurred AllowedPaymentMethodTy xs string pe The payment method type Specify the value InstantPaymentOnly PaymentRequestID xs string A unique identifier of the specific payment request Required when implementing parallel payments Character length and limitations Up to 127 single byte characters PaymentDetailsltemType Fields Field Description Name xs string Item name Character length and limitations 127 single byte characters Description xs string Item description Character length and limitations 127 single byte characters This field is available since version 53 0 Amount ebl BasicAmountType Cost of item NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Number xs string Item number Character length and limitations 127 single byte characters August 2012 SOAP API Developer Reference ExpressCheckout API Operations mI GetExpressCheckoutDetails API Operation Field Description Quantity xs integer Item quantity
379. ransactionSearch API operation to obtain all payments associated with the identified profile PayerName Fields Field Description Salutation FirstName MiddleName LastName Suffix xs string Optional Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Optional Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Optional Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Optional Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Optional Buyer s suffix Character length and limitations 12 single byte characters August 2012 SOAP API Developer Reference TransactionSearch API Operation Lm TransactionSearch Response Message TransactionSearch Response Message fe PaymentTransactionSearchResultType te AbstractResponseType Timestamp 0 1 dateTime Ack AckCodeType Timestamp dateTime Timezone string el CorrelationID 0 1 string Type string e Errors 0 ErrorType gt Payer EmailAddressType Version string PayerDisplayName string Build string TransactionID string PE any Status string GrossAmount BasicAmountType FeeAmount BasicAmountType NetAmount BasicAmountType E TransactionSearchResponseType vee JE PaymentTransactions 0 PaymentTransac
380. rcwince J 1 sting i Country 3 1 CounbrsCode pe HE Country vare J 1 sting Phone 2 1 sting E PostaCoce L2 1 string E AudresstD 3 1 sti E Addressdvner 2 1 AddrecsOanerCadeT vps Ezler ale ess I 3 41 sting IrtarnaticralNama 2 1 string E di tamain elStde ndskr 3 1 tiny IrtarnaticralStrest 2 1 sting El Addressstatus 2 1 Addressstetuscode ype E T dadnetalstyne E azllTywz 0 1 stig axId 10 1 string i EnharcscPsysrirto ype amp tbayPayertnfo U EbavPaverlnfclype NOTE Not all fields shown are available for use Use only the fields described in the documentation i EidianzdPa vType E Mhapa n ppe sel e E dpP yz 23 1 Elo PayerbiluTpe ms E Credtap irationecied f 1 nz NOTE Not all fields shown are available for use Use only the fields described in the documentation 112 August 2012 SOAP API Developer Reference e OrderTotal ItemTotal e ShippingTotal HandlingTotal TaxTotal e OrderDescription e Custom InvoiceID ButtonSource NotifyURL e ShipToAddress e Shippingmethod e ProfileAddressChangeDate PaymentDetailsItem InsuranceTotal e ShippingDiscount InsuranceOptionOffered e AllowedPaymentMethod E EnhancedPaymentData e SellerDetails e NoteText e TransactionId e PaymentAction PaymentRequestID E OrderURL e
381. rdNumberTypeType ReferenceCreditCardDetailsType e CreditCardNumberType 0 1 CreditCardNumberTypeType e CreditCardType 0 1 CreditCardTypeType e ExpMonth 0 1 int e CreditCardNumber 0 1 string e ExpYear 0 1 int CardOwnerName 0 1 PersonNameType E PersonNameType se e BillingAddress 0 1 AddressType e Salutation 0 1 SalutationType e cvz 0 1 string e FirstName 0 1 MameType StartMonth 0 1 int e MiddleName 0 1 MameType StartYear 0 1 int e LastName 0 1 MameType IssueNumber 0 1 string Suffix 0 1 SuffixType E AddressType Name 0 1 string e Streeti 0 1 string Street2 0 1 string e CityName 0 1 string StateOrProvince 0 1 string dE Country 0 1 CountryCodeType AP CountryName 0 1 string e Phone 0 1 string PostalCode 0 1 string e AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType e External ddressID 0 1 string e InternationalName 0 1 string e InternationalStateAndCity 0 1 string InternationalStreet 0 1 string e AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation DoReferenceTransaction Request Fields Field Description ReferenceID xs string Required A transaction ID from a previous purchas
382. rder authorization e Void of an order The value of ParentTransactionIDis the original OrderID Character length and limitations 16 digits xs string Receipt identification number Character length and limitations 16 digits in xxxx xxxx xxxx xxxx format ns PaymentTransactionCodeType The type of transaction It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters ebl PaymentCodeType Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters xs dateTime Time date stamp of payment Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z ebl BasicAmountType The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 174 August 2012 SOAP API Developer Reference GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description FeeAmount SettleAmount TaxAmount ExchangeRate ebl BasicAmountType PayPal fee amount charged for the transaction
383. recommend denial of the payment PendingFilters xs RiskFilterListType List of filters that caused the payment to become pending August 2012 SOAP API Developer Reference DoDirectPayment API Operation DoDirectPayment Response Message Field Description ReportsFilters xs RiskFilterListType List of filters that caused the payment to become flagged RiskFilterListType Fields Field Description ID xs int Filter ID It is one of the following values e 1 AVS No Match e 2 AVS Partial Match 3 AVS Unavailable Unsupported 4 Card Security Code CSC Mismatch 5 Maximum Transaction Amount 6 Unconfirmed Address 7 Country Monitor 8 Large Order Number 9 Billing Shipping Address Mismatch 10 Risky ZIP Code 11 Suspected Freight Forwarder Check 12 Total Purchase Price Minimum 13 IP Address Velocity 14 Risky Email Address Domain Check 15 Risky Bank Identification Number BIN Check 16 Risky IP Address Range 17 PayPal Fraud Model Name xs string Filter name Description xs string Filter description SOAP API Developer Reference August 2012 69 4 DoDirectPayment API Operation DoDirectPayment Response Message ThreeDSecure Response Fields Field Description VPAS Visa Payer Authentication Service status The value indicates whether Verified by Visa confirms that the information received is acceptable It is eturned only for Verified by Visa transactions Authentication
384. red August 2012 SOAP API Developer Reference API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11560 11561 11562 Invalid payer country Invalid period status Denied Denied This feature is not available at this time Invalid currency code Start Date is required Start Date should be valid Profile ID is missing from the request Invalid profile ID Invalid action value provided Note is missing from the request Invalid profile status for cancel action profile should be active or suspended Invalid profile status for suspend action profile should be active Invalid profile status for reactivate action profile should be suspended Invalid activation type Invalid initial amount Invalid auto bill type The payer s country is currently not supported The trial period status must be one of A ctive or C ancelled Payer s account is denied Merchant account is denied Recurring payments feature is not currently available try again later Invalid currency code all currency codes much match Subscription start date is required Subscription start date should be valid Profile ID is missing from the request The profile ID is invalid Invalid action value provided Note is missing
385. rence Revision History Date Description 10 August 2012 Maintenance release Added CV V2 response codes E and I for Visa Mastercard Discover and American Express 7 August 2012 Maintenance release New 10486 error code added for redirects when the process declines the transaction The transaction couldn t be completed Please redirect your customer to PayPal 10 July 2012 Updated for 92 0 Added new MsgSubID field for the following APIs for both requests and responsees RefundTransaction DoReferenceTransaction DoAuthorization and DoCapture 12 June 2012 Maintenance release 22 May 2012 Maintenance release 2 May 2012 Updated for 89 0 Added new field to SetExpressCheckout and DoReferenceTransaction Request APIs Added new error to DoReferenceTransaction Request API 3 April 2012 Updated references to Website Payments Standard and Website Payments Pro to PayPal Payments Standard and PayPal Payments Pro respectively 14 February 2012 Maintenance release 24 January 2012 Maintenance release updated for 85 0 1November 2011 Updated for 84 0 Added new field and a new type to RefundTransaction API 1 September 2011 5 April 2011 8 March 2011 26 January 2011 15 September 2010 request Added new field to DoDirectPayment API and DoReferenceTransaction API responses Edits to improve accuracy General edits to improve consistency Updated for 71 0 Added new fields to the DoExpressCheckout API response to return infor
386. request field 93 FundingSourceDetailsType request fields 102 G GBP 369 370 Get ExpressCheckout Details request fields 106 GetBalance API operation 155 GetBalance request fields 155 GetBalance request message 155 GetBalance response fields 156 GetBalance response message 156 GetBillingA greementCustomerDetails API operation 240 GetBillingA greementCustomerDetails request fields 240 GetBillingA greementCustomerDetails request message 240 GetBillingA greementCustomerDetails response fields 242 GetBillingA greementCustomerDetails response message 241 GetExpressCheckoutDetails API operation 106 GetExpressCheckoutDetails request message 106 GetExpressCheckoutDetails response fields 114 GetExpressCheckoutDetails response message 107 GetPalDetails API operation 157 GetPalDetails request message 157 GetPalDetails response fields 158 GetPalDetails response message 158 GetRecurringPaymentsProfileDetails API operation 204 GetRecurringPaymentsProfileDetails request fields 204 GetRecurringPaymentsProfileDetails request message 204 GetRecurringPaymentsProfileDetails response fields 209 GetRecurringPaymentsProfileDetails response message 205 GetTransactionDetails API operation 161 GetTransactionDetails request fields 161 GetTransactionDetails request message 161 GetTransactionDetails response fields 168 August 2012 GetTransactionDetails response message 162 GiftMessage requ est field 129 GiftMessage respons
387. ribed in the documentation SOAP API Developer Reference August 2012 237 FE Recurring Payments and Reference Transactions API Operations CreateBillingAgreement API Operation SetCustomerBillingAgreement Response Fields Field Description Token xs string A unique time stamped token which uniquely identifies this transaction in subsequent API calls NOTE The token expires after 3 hours Character length and limitations 20 single byte characters CreateBilling Agreement API Operation The CreateBillingAgreement API operation creates a billing agreement with a PayPal account holder CreateBillingAgreement is only valid for reference transactions CreateBillingAgreement Request Message te AbstractRequestType ExpressCheckoutTokenType e Detail evel 0 DetaillevelCodeType ErrorLanguage 0 1 string Version string 1 fel any 0 1 CreateBiling greementRequestType see e Token ExpressCheckoutTokenType NOTE Not all fields shown are available for use Use only the fields described in the documentation CreateBillingAgreement Request Fields Field Description Token xs string Required The time stamped token returned in the SetCustomerBillingAgreement response NOTE The token expires after 3 hours Character length and limitations 20 single byte characters 238 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API O
388. ring of up to 38 single byte characters This field is available since version 92 0 MerchantStoreDetailsTypeFields Field Description StoreID xs string Identifier of the merchant store at which the refund is given This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 82 0 SOAP API Developer Reference August 2012 277 DE RefundTransaction API Operation RefundTransaction Response Message Field Description TerminalID xs string Optional ID of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 RefundTransaction Response Message Tie AbstractResponseType Timestamp 0 1 dateTime Ack AckCodeType BasicAmountType 8 currencyID CurrencyCodeType re RefundinfoType CorrelationID 0 1 string e Errors 0 4 ErrorType Version string e Build string F any RefundStatus 0 1 PaymentStatusCodeType e le PendingReason 0 1 PendingStatusCodeType E RefundTransactionResponseType RefundTransactionID 0 1 Transactionid E NetRefundAmount 0 1 BasicAmountType FeeRefundAmount 0 1 BasicAmountType GrossRefundAmount 0 1 BasicAmountType TotalRefundedAmount 0 1 BasicAmountType 1g RefundInfo 0 1 RefundinfoType e ReceiptData 0 1 string
389. riod will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles cc BasicAmount Type Required Billing amount for each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma xs int Optional Number of billing cycles for trial payment period 228 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 UpdateRecurringPaymentsProfile API Operation Field Description TrialPeriod Amount cc BasicAmountType Billing amount for each billing cycle during this payment period required if you specify an optional trial period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separat
390. rors Error Code Short Message Long Message Corrective Action 10535 Gateway Decline This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card number and type 10536 Invalid Data This transaction cannot be The merchant entered an invoice ID that processed is already associated with a transaction by the same merchant By default the invoice ID must be unique for all transactions To change this setting log into PayPal or contact customer service 10537 Filter Decline This transaction cannot be The transaction was declined by the processed country filter managed by the merchant To accept this transaction change your risk settings on PayPal 10538 Filter Decline This transaction cannot be The transaction was declined by the processed maximum amount filter managed by the merchant To accept this transaction change your risk settings on PayPal 10539 Filter Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 10540 Invalid Data The transaction cannot be The transaction was declined by PayPal processed due to an invalid because of an invalid address address 10541 Gateway Decline This transaction cannot be The credit card entered is currently processed Please enter a valid restricted by PayPal Contact PayPal for credit card number and type more information 10542 Invalid Data This transaction cannot be The e
391. rring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment This field is introduced in version 80 0 of the API SOAP API Developer Reference August 2012 379 What s New in Version 74 0 What s New in Version 74 0 New Behavior of DoExpressCheckoutPayment By default the DoExpressCheckout Payment API operation is idempotent for all API callers You can call DoExpressCheckout Payment up to a maximum of 10 times and it returns the same result The exceptions are when DoExpressCheckoutPayment generates an error or the token expires This functionality only works with version 74 0 or greater There is no change to DoExpressCheckout Payment functionality if you are not updating to the latest version of the API If you update to version 74 0 or higher but want to opt out of this functionality contact PayPal New DoExpressCheckoutPayment Error Code Error Code Short Message Long Message Correcting This Error 13751 Could not retrieve the Transaction completed original successful successfully but could not response retrieve the original successful response What s New in Version 72 0 Changes to BuyerDetailsType in SetExpressCheckout Request BuyerDetailsType Fields Field Description TaxIdDetails ebl TaxIdDetailsType Details ab
392. rt Message Long Message Additional Information 10004 10404 10004 10405 10407 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Invalid argument BillingType input field is set to None ReturnURL is missing Invalid value for request billing address parameter Cancel URL is missing Invalid buyer email address BuyerEmail ReturnURL tag has no content CancelURL tag has no content Invalid BuyerEmail badly formatted or violates SMTP protocol defined email address format or BuyerEmail is passed as an empty tag SOAP API Developer Reference August 2012 345 346 API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 10436 Transaction refused PageStyle value exceeds maximum PageStyle tag is too long because of an invalid allowable length argument See additional error messages for details 10437 Transaction refused cpp header image value exceeds cpp header image tag is too becau
393. rt Message Long Message Correcting This Error 10001 Internal Error Internal Error 10001 Internal Error Warning an internal error has occurred The transaction id may not be correct 10001 Internal Error The transaction could not be loaded 10002 Restricted account Account is restricted 10004 Transaction refused The partial refund amount must be a because of an invalid positive amount argument See additional error messages for details 10004 Transaction refused You can not specify a partial amount because of an invalid with a full refund argument See additional error messages for details 10004 Transaction refused A transaction id is required because of an invalid argument See additional error messages for details 10004 Transaction refused The transaction id is not valid because of an invalid argument See additional error messages for details 10007 Permission denied You do not have permission to refund this transaction 10007 Permission denied You do not have permissions to make this API call SOAP API Developer Reference August 2012 333 API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10009 Transaction refused You do not have a verified ACH This error can be caused by insufficient funds in your PayPal balance to cover the amount of the refund and either of the following e Not having yet verified the bank account associated with your PayPal account e
394. s this field is required and must be set to Order When implementing digital goods this field is required and must be set to Sale If the transaction does not include a one time purchase this field is ignored It is one of the following values e Sale This is a final sale for which you are requesting payment default e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to Sale in SetExpressCheckout request and then change the value to Authorization or Order in the DoExpressCheckoutPayment request If you set the field to Authorization or Order in Set ExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters PaymentRequestID xs string A unique identifier of the specific payment request Required when implementing parallel payments Character length and limitations Up to 127 single byte characters PaymentDetailsltemType Fields Field Description Name xs string Item name This field is required when you pass a value for ItemCategory Character length and limitations 127 single byte characters This field is introduced in version 53 0 Description xs string Optional Item description Character length and limitations 127 single byte characters This fi
395. s Layer SSL data transport A failure of authenticated security at any one of these levels denies access to the PayPal SOAP API service SOAP RequesterCredentials Username Password Signature and Subject For the security of your business PayPal must verify that merchants or third party developers are permitted to initiate a transaction before they make one PayPal authenticates each request If the request cannot be authenticated a SOAP security fault is returned In the SOAP request header your SOAP client must set the Username Password elements to pass an API username password combination In addition you can set the Signature or Subject elements to specify your API signature string and an optional third party account email address for authentication The following example shows part of the RequesterCredentials elements These elements are required for all SOAP requests lt SOAP ENV Header gt lt RequesterCredentials xmlns urn ebay api PayPalAPI xsi type ebl CustomSecurityHeaderType gt Credentials xmlns urn ebay apis eBLBaseComponents xsi type ebl UserIdPasswordType gt lt Username gt api username Username lt Password gt api password Password lt Signature gt api signature Signature lt Subject gt authorizing account emailadaress lt Sub ect Credentials lt RequesterCredentials gt lt SOAP ENV Header gt SOAP API Developer Reference August 2012 17 Ds PayPal SOAP
396. s for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details ButtonSource value truncated Transaction refused because of an invalid argument See additional error messages for details Invoice ID value exceeds maximum allowable length Value of Order Description has been truncated Value of Custom element has been truncated PageStyle value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length The NotifyURL element value exceeds maximum allowable length The ButtonSource element value exceeds maximum allowable length Sale is only allowed PaymentAction SOAP API Developer Reference August 2012 309 310 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10457 Error occurred in eBay API creation error communicating to eBay 10458 Error occurred in eBay API unknown failure communicating
397. sCheckout API Operations CEN GetExpressCheckoutDetails API Operation Field Description OrderTotal ebl BasicAmountType The total cost of the transaction to the buyer If shipping cost not applicable to digital goods and tax charges are known include them in this value If not this value should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to O if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged Purchase specific fields are ignored For digital goods the following must be true e total cost gt 0 e total cost lt total cost passed in the call to SetExpressCheckout NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ItemTotal ebl BasicAmountType Sum of cost of all items in this order For digital goods this field is required PayPal recommends that you pass the same value in the call to DoExpressCheckoutPayment that you passed in the call to SetExpressCheckout
398. sType E PaymentDetailsType e CreditCard 0 1 ReferenceCreditCardDetails Type OrderTotal 0 1 El IPAddress 0 1 string tem Total 0 1 e MerchantSessionld 0 1 string Shipping Total 0 1 e ReqConfirmShipping 0 1 string Handling Total 0 1 e SoftDescriptor 0 1 string TaxTotal 0 1 e SenderDetails 0 1 SenderDetailsType OrderDescription 0 1 string Custom 0 1 string InvoicelD 0 1 string ButtonSource 0 1 string Notify URL 0 1 string ShipToAddress 0 1 AddressType ShippingMethod 0 1 ShippingServiceCodeType ProfileAddressChangeDate 0 1 dateTime PaymentDetailsltem 0 4 PaymentDetailsltemType ee InsuranceTotal 0 1 ShippingDiscount 0 1 InsuranceOptionOffered 0 1 string AllowedPaymentMethod 0 1 AllowedPaymentMethodType EnhancedPaymentData 0 1 SellerDetails 0 1 SellerDetailsType NoteText 0 1 string Transactionld 0 1 string PaymentAction 0 1 PaymentActionCodeType PaymentRequestiD 0 1 string Order URL 0 1 string SoftDescriptor 0 1 string BranchLevel 0 1 integer OfferDetails 0 1 OfferDetails Type Recurring 0 1 RecurringFlagType e e e e e e e e e e e e e le e e e e e e e e e e e le e e e E ReferenceCreditCardDetails Type ie CreditCardNumberType 0 1 CreditCardNumberTypeType e ExpMonth 0 1 int le Exp Year 0 1 int le CardOwnerN
399. sType e Timestamp 0 1 dateTime el Token ExpressCheckoutTokenType el Ack AckCodeType el PaymentInfo 0 10 PaymentInfoType e CorrelationID 0 1 string el BillingAgreementID 0 1 string Errors 0 ErrorType el RedirectRequired 0 1 string Version string el Note 0 1 string Build string SuccessPageRedirectRequested 0 1 string FE any 0 1 e UserSelectedOptions 0 1 UserSelectedOptionType FMFDetalstype AcceptFillers 0 1 RiskFilterListType E DoExpressCheckoutPaymentResponseType e PendingFilters 0 1 RiskFilterListType DenyFilters 0 1 RiskFilterListType ReportFilters 0 1 RiskFilterListType e E DoExpressCheckoutPaymentResponseDetails 1 1 DoExpressCheckoutPaymentResponseDetailsType e FMFDetails 0 1 FMFDetailsType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 139 140 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation E DoFxpressCher lt o FPaymencP espansesEails Tyne Tosen ExpresgCheckoutToker Type FaymantInfo C 10 PaymcntIn oTyac E Eillnq grosnantID C 1 string RedrectRequired C 1 string E Note C 1 string SuzccssPcgoRodiroctoguested C 1 string UssrSc ectedopzions C 1 UscrscloctodOptonT pc E ExaressChecko t oken ype i Payne th uT
400. schema design decisions that can affect how businesses design their own applications e Enumerations Enumerations are defined directly in the PayPal API schema e Troubleshooting information The PayPal API returns information about elements that trigger errors e Backward compatibility The PayPal API is versioned so that business applications are backward compatible when new elements are introduced to the server side schema NOTE eBL defines many structures that are specific to processing auctions PayPal s SOAP schema includes these definitions to maintain compatibility with eBay s SOAP and for possible future joint use of SOAP across both eBay and PayPal The material focuses only on those SOAP definitions pertinent to use of the PayPal SOAP API August 2012 SOAP API Developer Reference PayPal SOAP API Basics FEN Security Security The PayPal SOAP API service is protected to ensure that only authorized PayPal members use it There are four levels of security 1 A required API username Username field and API password Password field 2 A third required authentication mechanism which is either one of the following Client side request signing using a PayPal issued API Certificate Request authentication using an API Signature included in the request Signature field 3 An optional third party authorization to make the API call on some other account s behalf the optional Subject field 4 Secure Socket
401. se of an invalid maximum allowable length long maximum length is 127 argument See additional error messages for details 10438 Transaction refused cpp header border color value cpp header border color tag is because of an invalid exceeds maximum allowable too long maximum length is 6 argument See additional length error messages for details 10439 Transaction refused cpp header back color value cpp header back color tag is because of an invalid exceeds maximum allowable too long maximum length is 6 argument See additional length error messages for details 10440 Transaction refused cpp payflow color value exceeds cpp payflow color tag is too because of an invalid maximum allowable length long maximum length is 6 argument See additional error messages for details 10471 Transaction refused ReturnURL is invalid ReturnURL tag contains invalid because of an invalid URL argument See additional error messages for details 10472 Transaction refused CancelURL is invalid CancelURL tag contains invalid because of an invalid URL argument See additional error messages for details 10476 Transaction refused because of an invalid argument See additional error messages for details 10477 Transaction refused because of an invalid argument See additional error messages for details 10485 Payment not authorized Payment has not been authorized by the user 11452 Merchant not enabled for Merchant not enabled for reference This m
402. sed in the call to SetExpressCheckout NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 131 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ShippingTotal InsuranceTotal ShippingDiscount InsuranceOptionOffered HandlingTotal ebl BasicAmountType Optional Total shipping costs for this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Optional Total shipping insurance costs for this order The value must be a non negative currency amount or nul 1 if you offer insurance options NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies
403. sltemTypein SetExpressCheckout and DoExpressCheckoutPayment Requests 0 e e 384 Changes to PaymentDetailsltemType in GetExpressCheckoutDetails Response 385 Revision History 4 aa vis as ok e eec oue o Sue ee e oe a a OL nd x 1 sos ske ne Gea we be Es ee a a BOOT SOAP API Developer Reference August 2012 9 EN Contents 10 August 2012 SOAP API Developer Reference What s New What s New in Version 93 0 Maintenance release New 10486 error code added for redirects when the process declines the transaction The transaction couldn t be completed Please redirect your customer to PayPal SOAP API Developer Reference August 2012 11 a What s New in Version 93 0 12 August 2012 SOAP API Developer Reference Preface About This Guide The SOAP API Developer Reference describes the PayPal SOAP API Intended Audience This guide is written for developers who are implementing solutions using the SOAP API It is written for developers who are implementing solutions using the SOAP API Where to Go for More Information e Express Checkout Integration Guide e Express Checkout Advanced Features Guide e Merchant Setup and Administration Guide Documentation Feedback Help us improve this guide by sending feedback to documentationfeedbackepaypal com SOAP API Developer Reference August 2012 13 al Documentation Feedback 14 August 2012 SOAP API Developer
404. sponse message 246 BillingAgreement Details request field 92 233 BillingAgreementCustom request field 104 237 246 BillingAgreementCustom response field 249 BillingAgreementDescription request field 104 237 246 BillingAgreementDescription response field 248 BillingAgreementDetails request fields 103 236 Billing AgreementID response field 143 239 268 BillingAgreementMax response field 249 BillingAgreementStatus request field 245 BillingAgreementStatus response field 249 BillingFrequency response field 212 BillingPeriod response field 212 BillingPeriodDetailsType request fields 195 228 BillingPeriodDetailsType response fields 212 BillingStartdate request field 193 227 BillingStartdate response field 211 BillingType request field 103 236 BillingType response field 248 BillOutstanding API operation 219 August 2012 391 BillOutstandingAmount request fields 219 BillOutstandingAmount request message 219 BillOutstandingAmount response fields 220 BillOutstandingAmount response message 220 BrandName request field 93 Brazilian Real 369 BRL 369 Business response field 171 ButtonSource request field 63 130 133 260 BuyerDetails request field 93 BuyerDetailsType request fields 102 BuyerEmail request field 91 236 BuyerEmailOpti nEnable request field 94 Buyerld request field 102 BuyerID response field 180 BuyerMarketingEmail request field 129 BuyerMarketingEmail response field 116 170 BuyerRegistrationDate request field 102
405. ssage 239 CreateRecurringPaymentsProfile API operation 187 CreateRecurringPaymentsProfile request fields 192 CreateRecurringPaymentsProfile request message 187 CreateRecurringPaymentsProfile response fields 203 CreateRecurringPaymentsProfile response message 203 CreditCard request field 57 74 193 227 CreditCard response field 210 CreditCardDetailsType request fields 58 75 199 229 263 CreditCardDetailsType response fields 214 CreditCardNumber request field 58 75 199 230 263 CreditCardNumber response field 214 CreditCardType request field 58 75 199 229 263 CreditCardType response field 214 currencies 24 currency codes 369 370 CurrencyCode request field 283 CurrentRecurring PaymentsPeriod response field 210 Custom request field 63 87 98 133 260 Custom response field 114 121 178 CustomerServiceNumber request field 93 CVV2 request field 58 75 199 230 263 CVV2 response codes 373 CVV2Code response field 68 268 Czech Koruna 369 370 CZK 369 370 SOAP API Developer Reference D Danish Krone 369 370 date time formats 24 DenyFilters response field 68 152 273 Description request field 64 99 135 194 202 225 261 382 384 Description response field 69 122 153 209 274 Discover AVS response codes 371 Discover CVV2 response codes 373 DKK 369 370 Do Reauthorization request fields 45 Do Reauthorization response fields 45 DoAuthorization API operation 40 DoAuthorization request fiel
406. st 2012 197 FE Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation AddressType Shipping Fields Field Description Name Streetl Street2 CityName StateOrProvince PostalCode Country Phone xs string Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters xs string First street address It is required if using a shipping address Character length and limitations 100 single byte characters xs string Optional Second street address Character length and limitations 100 single byte characters xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters ebl CountryCodeType Country code It is required if using a shipping address Character length and limitations 2 single byte characters xs string Optional Phone number Character length and limitations 20 single byte characters 198 August 2012 SOAP API Developer Refer
407. string Phone 0 1 string PostalCode 0 1 string e AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType e External ddressID 0 1 string InternationalName 0 1 string e International5tateAndCity 0 1 string InternationalStreet 0 1 string e AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation DoNonReferencedCredit Request Fields Field Description Amount ns BasicAmountType Required Total of order including shipping handling and tax Amount NetAmount ShippingAmount TaxAmount Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 73 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description NetAmount ns BasicAmount Type Optional Total amount of all items in this transaction NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma TaxAmount ns BasicAmount Type
408. sts This field is available since version 64 0 PaymentErrorType Fields Field Description ShortMessage xs string Payment error short message LongMessage xs string Payment error long message ErrorCode xs string Payment error code SeverityCode xs string Payment error severity code ErrorParameters xs string Application specific error values indicating more about the error condition SOAP API Developer Reference August 2012 125 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation TaxldDetailsType Fields Field Description TaxIdType xs string Buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR CPF for individuals and BR CNPJ for businesses This field is introduced in API version 72 0 TaxId xs string Buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte characters for individuals and 14 single byte characters for businesses This field is introduced in API version 72 0 DoExpressCheckoutPayment API Operation The DoExpressCheckoutPayment API operation completes an Express Checkout transaction If you set up a billing agreement in your SetExpressCheckout API call the billing agreement is created when you call the DoExpressCheckoutPayment API operation DoExpressCheckoutPayment Request Message te AbstractRequest Type
409. t 2012 107 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 5 ExpressCheckou TokenType e Ge ExpressCheckoutDetailsResponseDetalsTrpe Token ExpressheckoutTokenTy2e E Paye In o PayerIrfo ype E PayerInfoType Custom 4 1 string s Payer 0 1 Cnail ddressType InvoieD 0 1 string e PayerID 0 1 User DType Contact hone U 1 string PayerStatus 0 1 PayPallserStatusCodeTyre e FilincAgresment rrenbedstatis 1 1 hanlear e PayerNam PersonhameTpe kedrectkequred U 1 string s PayerCauntry 0 1 CourtryCodeTyps e RilincArdress n 1 AddressType PayerBusiness 0 1 sting Note U string s Address 0 1 AddrsssType CherenntStakus n 1 string ContactPhone 0 1 sting E PayPaladjustmert U BasicAmount lype s TaxldDsteils D 1 TaxIdDetaisT pe ves E Payrren Netaik 0 10 PaynertNetalsTyne EnhancadPayerhfc 0 1 EnhancedPsyerInfo ype UserselectedGptions 0 1 UserselzctedOptionType e TreentiveDetals n TnrertiveCetailsType E AddressType GitMessags 0 1 string name 1 string e GFtR ceiptzmable 0 1 string resti 1 string GitwrapName L0 1 string xrestz 41 string e GrFtWrapAnount 0 1 BasicAmountType CityNane 1 string Buye MarketingEmai 10 1 string xtatsOrProvince 41 string E SurveyQu
410. t Maestro card was issued Character length and limitations 4 digits xs string Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum PayerlnfoType Fields Field Description Payer FirstName ns EmailAddressType Optional Email address of buyer Character length and limitations 127 single byte characters ns PersonNameType Required Buyer s first name Character length and limitations 25 single byte characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 UpdateRecurringPaymentsProfile API Operation Field Description LastName ns PersonNameType Required Buyer s last name Character length and limitations 25 single byte characters Address ns AddressType Required Buyer s billing address information AddressType Fields Field Description Streetl xs string Required First street address Character length and limitations 100 single byte characters Street2 xs string Optional Second street address Character length and limitations 100 single byte characters CityName xs string Required Name of city Character length and limitations 40 single byte characters StateOrProvince xs string Required State or province Character length and limitations 40 single byte characters Country ebl CountryCodeType Required Country code Character length and limitati
411. t the marketplace site Optional Character length and limitations 13 single byte alphanumeric characters xs string Current name of the merchant or business at the marketplace site This name may be shown to the buyer xs dateTime Date when the merchant registered with the marketplace Character length and limitations Date and time are in UTC GMT format For example 2011 06 24T05 38 7482 SOAP API Developer Reference August 2012 143 o ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ParentTransactionID ReceiptID ExpectedeCheckClear Date ShippingMethod InstrumentCategory OfferCode OfferTrackingID ns Transactionld Parent or related transaction identification number This field is populated for the following transaction types e Reversal e Capture of an authorized transaction e Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderTD e Authorization of an order The value of ParentTransactionID is the original OrderTD e Capture of an order authorization e Void of an order The value of ParentTransactionIDis the original OrderTD Character length and limits 19 single byte characters maximum ns ReceiptID Character length and limitations 16 digits in xxxx xxxx xxxx xxxx format xs dateTime eCheck latest expected clear date xs string Shipping method selected by the user during check o
412. t value exceeds maximum allowable length This transaction cannot be processed Please enter a valid Credit Card Verification Number This transaction cannot be processed Please enter a valid credit card number and type The transaction was refused because the country was prohibited as aresult of your Country Monitor Risk Control Settings The transaction was refused because the maximum amount was excused as a result of your Maximum Amount Risk Control Settings Payment declined by your Risk Controls settings PayPal Risk Model This transaction cannot be processed The issue number of the credit card is invalid A Start Date or Issue Number is required Authorization voided Authorization has expired Order has expired Order is voided Maximum number of authorization allowed for the order is reached NotifyURL field is too long maximum length for notify URL is 2048 ButtonSource field is too long maximum length is 32 Warning only API executes CVV2 field is invalid CreditCardNumber and or CreditCardType is invalid Transaction refused due to country monitor risk control Transaction refused due to max amount risk control Transaction declined by Risk Control settings PayPal Risk model IP fraud models failed IssueNumber is invalid None of Start date or issue number is specified only applies to Switch credit cards SOAP API Developer Reference August 2012 353
413. tDetails ebl PaymentDetailsType Required Information about the credit card to be charged IPAddress xs string Required IP address of the buyer s browser NOTE PayPal records this IP addresses as a means to detect possible fraud Character length and limitations 15 single byte characters including periods for example 255 255 255 255 MerchantSessionId xs string Optional Your customer session identification token NOTE PayPal records this optional session identification token as an additional means to detect possible fraud Character length and limitations 64 single byte numeric characters ReturnFMFDetails xs boolean Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details ThreeDSecureRequest ns ThreeDSecureRequestType Optional Information about 3 D Secure settings UK only SOAP API Developer Reference August 2012 57 4 DoDirectPayment API Operation DoDirectPayment Request Message CreditCardDetailsType Fields Field Description CreditCardType ebl CreditCardType Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e
414. tation FirstName MiddleName LastName Suffix xs string Buyer s salutation Character length and limitations 20 single byte characters ebl PersonNameType Buyer s first name Character length and limitations 25 single byte characters ebl NameUser Buyer s middle name Character length and limitations 25 single byte characters ebl NameType Buyer s last name Character length and limitations 25 single byte characters ebl SuffixType Buyer s suffix Character length and limitations 12 single byte characters AddressType Fields Field Description AddressOwner AddressStatus Name ebl AddressOwnerTypeCode eBay company that maintains this address It is one of the following values e eBay e PayPal ebl AddressStatusTypeCode Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed xs string Person s name associated with this address Character length and limitations 32 single byte characters August 2012 SOAP API Developer Reference GetTransactionDetails API Operation CENT GetTransactionDetails Response Message Field Description Streetl xs string First street address Character length and limitations 100 single byte characters Street2 xs string Second street address Character length and limitations 100 single byte characters CityName xs string Name of city Character length and limitations 40 single b
415. tations 32 single byte alphanumeric characters NotifyURL xs string Optional Your URL for receiving Instant Payment Notification IPN about this transaction If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists IMPORTANT The notify URL applies only to DoExpressCheckoutPayment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters 260 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReferenceTransaction API Operation Field Description ShipToAddress ns AddressType Optional Address the order is shipped to PaymentDetailsItem ebl PaymentDetailsItemType Optional Details about each individual item included in the order Recurring ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e yY This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment This field is introduced in version 80 0 of the API PaymentDetailsltemType Fields Field Description ItemCategory ns ItemCategoryType Indicates whether the i
416. tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid SOAP API Developer Reference August 2012 297 298 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10717 Invalid Data There s an error with this
417. tem is digital or physical For digital goods this field is required and you must set it to Digital to get the best rates It is one of the following values e Digital e Physical This field is introduced in version 69 0 Name xs string Item name This field is required when you pass a value for ItemCategory Character length and limitations 127 single byte characters Description xs string Optional Item description This field is available since version 53 0 Character length and limitations 127 single byte characters Amount ebl BasicAmountType Cost of item This field is required when you pass a value for ItemCategory NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SOAP API Developer Reference August 2012 261 FE Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description Number xs string Optional Item number Character length and limitations 127 single byte characters Quantity xs integer Item quantity This field is required when you pass a value forItemCategory Character length and limitations Any
418. temType SOAP API Developer Reference ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOTE Not all fields shown are available for use Use only the fields described in the documentation E EnsencedFavrrentLetsTyp2 E F yP is Ie al Type E EbayFavmen Detzlk C 1 zbavP zymenttiecallzType fe F ey selon elais 1 1 A aridlafiriads e 9 Rezun_AT Decals 10 11 tira wl El nctrumentbstals 3 1 tnzzrurenzbetziElvps El CIT n ed ad 1 1 fferPiel als T e afl amp rInsI rerary C 1 Grinettingrary 2 Silneltinerery 72e 2 Passengar vane Al string Issuelate A string 2 TavelAgenzyName JJ string Travelagenz rZode A string al TchotMumb r string Issurguatrenloze JJ string 8 OLstemarCod gt d string e TldFa gt A Bard uu Type Ta axes 4 BascAroutType El T d4Fr AD Rasi nim d Type 8 Restr chedT chet i string el Meri iy uen AI rin earrqucunt Y sting El Fiy d el ads DU Figh Delais Typi NOTE Not all fields shown are available for use Use only the fields described in the documentation E EbaySele ZetalsType EbayScle Zetais 10 1 EbcySallzrDczallsTypc E Eav elerreedbacklozaPostrvzCacnt Jul int gldretnmentbetars U 17 Instruren betals ype E skavzelerreedbackTo alacatlvecun 723 1 Int El O fe Celads 0 1 CT Deal Type le Hareler erdhe kOe al Periti nto 7 1 int 3 8 tavzclerrocdbackO cralWizqazmeicun Jul int E zhavzelerfeedba
419. temType Structure in CreateRecurringPaymentsProfile Request PaymentDetailsltemType Fields Field Description ItemCategory New field ns ItemCategoryType Indicates whether the item is digital or physical goods For digital goods this field is required and you must set it to Digital to get the best rates It is one of the following values e Digital e Physical Name New field xs string Item name This field is required when you pass a value for ItemCategory Character length and limitations 127 single byte characters Description New field xs string Optional Item description Character length and limitations 127 single byte characters Amount New field ebl BasicAmountType Cost of item This field is required when you pass a value for ItemCategory NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD Number New field xs string Optional Item number Quantity New field xs integer Item quantity This field is required when you pass a value for ItemCategory Character length and limitations Any positive integer 382 August 2012 SOAP API Developer Reference What s New in Vers
420. the address information Partial matched 3 The merchant did not provide AVS Not applicable information Not processed 4 Address not checked or acquirer had Not applicable no response Service not available Null No AVS response was obtained Not applicable Default value of field Related information DoDirectPayment Response Fields 372 August 2012 SOAP API Developer Reference AVS and CVV2 Response Codes CVV2 Response Codes CVV2 Response Codes CVV2 Response Codes for Visa MasterCard Discover and American Express CVV2 Code Meaning Matched Details E Error Unrecognized or Unknown Not applicable response I Invalid or Null Not applicable M Match CVV2CSC N No match None P Not processed Not applicable S Service not supported Not applicable U Service not available Not applicable No response Not applicable CVV2 Response Codes for Maestro CVV2 Code Meaning Matched Details 0 Matched CVV2 1 No match None 2 The merchant has not implemented Not applicable CVV2 code handling 3 Merchant has indicated that CVV2 is Not applicable not present on card 4 Service not available Not applicable All others Error Not applicable SOAP API Developer Reference August 2012 373 EN AVS and CVV2 Response Codes CVV2 Response Codes 374 August 2012 SOAP API Developer Reference About Previous Versions of the API Previous versions of the API can still be used however PayPal recommends using the latest
421. the following values e any The merchant does not have a preference Use any available funding source e default Use the merchant s preferred funding source as configured in the merchant s profile e instant Use the merchant s balance as the funding source e eCheck The merchant prefers using the eCheck funding source If the merchant s PayPal balance can cover the refund amount use the PayPal balance NOTE This field does not apply to point of sale transactions This field is available since version 82 0 MerchantStoreDetail ns MerchantStoreDetailsType S Optional Information about the merchant store This field is available since version 82 0 RefundAdvice xs boolean Optional Flag to indicate that the buyer was already given store credit for a given transaction It is one of the following values e true The buyer was already given store credit for a given transaction e false The buyer was not given store credit for a given transaction This field is available since version 85 0 RefundItemDetails ebl InvoiceItemType Optional Details about the individual items to be returned MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations st
422. the payment page By default the color is white Character length and limitation 6 character HTML hexadecimal color code in ASCII xs string Optional Sets the background color for the payment page Character length and limitation 6 character HTML hexadecimal color code in ASCII ns EmailAddressType Optional Email address of the buyer as entered during checkout PayPal uses this value to pre fill the PayPal membership sign up portion of the PayPal login page Character length and limit 127 single byte alphanumeric characters BillingAgreementDetails Fields Field Description BillingType ns BillingCodeType Required Type of billing agreement For recurring payments this field must be set to RecurringPayments In this case you can specify up to ten billing agreements Other defined values are not valid Type of billing agreement for reference transactions You must have permission from PayPal to use this field This field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e MerchantInitiatedBillingSingleAgreement PayPal creates a single billing agreement for all transactions associated with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option 236 August 2012 SOAP AP
423. tion has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits CardOwner ns PayerInfoType Required Details about the owner of the credit card StartMonth xs int Optional Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary StartYear xs int Optional Year that Maestro card was issued Character length and limitations 4 digits SOAP API Developer Reference August 2012 199 200 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description IssueNumber xs string Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum PayerlnfoType Fields Field Description Payer PayerID PayerStatus PayerName PayerCountry PayerBusiness Address ebl EmailAddressType Required Email address of buyer Character length and limitations 127 single byte characters ebl UserIDType Optional Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters ebl PayPalUserStatusCodeType Optional Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters ebl PersonNameType Op
424. tionSearchResultType NOTE Not all fields shown are available for use Use only the fields described in the documentation E Email ddressType PaymentTransactionSearchResult Type Timestamp dateTime Timezone string fe Basic mountType Type string a currencyID CurrencyCodeType e Payer Email ddressType e PayerDisplayName string TE TransactionID string e Status string e Gross mount BasicAmountType e FeeAmount BasicAmountType e NetAmount BasicAmountType NOTE Not all fields shown are available for use Use only the fields described in the documentation TransactionSearch Response Fields Field Description Timestamp xs dateTime Date and time in UTC GMT that the transaction occurred SOAP API Developer Reference August 2012 285 14 TransactionSearch API Operation TransactionSearch Response Message Field Description Timezone xs string Time zone of the transaction The value is always GMT Type xs string Type of the transaction It is one of the following values e Currency Conversion credit e Currency Conversion debit Payment Recurring Payment Temporary Hold Transfer Donation Payer ebl EmailAddressType Email address of either the buyer or the payment recipient the payee If the payment amount is positive this field is the recipient of the funds If the payment is negative this field is the paying buyer PayerDisplayName
425. tional First and last name of buyer ebl CountryCodeType Optional Buyer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations 2 single byte characters xs string Optional Buyer s business name Character length and limitations 127 single byte characters xs string Optional Buyer s shipping address information PayerNameType Fields Field Description Salutation xs string Optional Buyer s salutation Character length and limitations 20 single byte characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 CreateRecurringPaymentsProfile API Operation Field Description FirstName ebl PersonNameType Optional Buyer s first name Character length and limitations 25 single byte characters MiddleName ebl NameUser Optional Buyer s middle name Character length and limitations 25 single byte characters LastName ebl NameType Optional Buyer s last name Character length and limitations 25 single byte characters Suffix ebl SuffixType Optional Buyer s suffix Character length and limitations 12 single byte characters AddressType Fields Field Description Streetl xs string Required First street address Character length and limitations 100 single byte characters Street2 xs string Optional Second street address Character len
426. tom element of the SetExpressCheckout request Character length and limitations 256 single byte alphanumeric characters xs string Your own invoice or tracking number as set by you in the element of the same name in the SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters August 2012 SOAP API Developer Reference ExpressCheckout API Operations eg GetExpressCheckoutDetails API Operation Field Description ContactPhone xs string Buyer s contact phone number NOTE PayPal returns a contact phone number only if your Merchant Account Profile settings require that the buyer enter one Character length and limitations Field mask is XXX XXX XXXX for US numbers or XXX XXXXXXXX for international numbers PaymentDetails ebl PaymentDetailsType Information about the payment PayPalAdjustment cc BasicAmountType A discount or gift certificate offered by PayPal to the buyer This amount is represented by a negative amount If the buyer has a negative PayPal account balance PayPal adds the negative balance to the transaction amount which is represented as a positive value Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma Note xs string Text entered by the buyer on the PayPal website if you set the A
427. tryTime response field 180 Retry Until request field 276 ReturnAllCurrencies request field 155 ReturnFMFDetails request field 57 129 256 ReturnURL request field 87 234 RiskFilterListType response fields 69 153 274 August 2012 397 S SalesTax response field 178 Salutation request field 60 76 200 264 284 Salutation response field 117 172 243 250 ScheduleDetails request field 193 ScheduleDetailsType request fields 194 SecureMerchantAccountID response field 152 security 17 SEK 369 370 SellerDetails request field 98 134 SellerDetails response field 150 SellerDetailsType request fields 138 SellerID request field 138 SellerRegistrationDate request field 138 SellerUserName request field 138 service architecture 15 service endpoints 18 SetCustomerBillingAgreement API operation 233 SetCustomerBillingA greement request fields 233 SetCustomerBillingA greement request message 233 SetCustomerBillingA greement response fields 238 SetCustomerBillingA greement response message 237 SetExpressCheckout API operation 79 SetExpressCheckout request message 79 SetExpressCheckout response fields 105 SetExpressCheckout response message 105 SettleAmount response field 146 175 270 SeverityCode response field 125 152 SGD 369 370 Sheqel 369 Shipp ingDiscountrequest field 132 ShippingAmount request field 74 226 229 ShippingAmount response field 213 ShippingCalculationMode response field 124 151 168 ShippingDiscount request fi
428. ttribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CurrencyCode xs token Optional Search by 3 character ISO 4217 currency code SOAP API Developer Reference August 2012 283 TransactionSearch API Operation TransactionSearch Request Message Field Description Status ProfileID ebl PaymentTransactionStatusCodeType Optional Search by transaction status It is one of the following values e Pending The payment is pending The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field e Processing The payment is being processed e Success The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending e Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returned to the buyer xs string Optional An alphanumeric string generated by PayPal that uniquely identifies a recurring profile You can specify the Profile ID in the T
429. turned off in your account ebl LandingPageType Optional Type of PayPal page to display It is one of the following values e Billing Non PayPal account e Login PayPal account login ebl ChannelType Optional Type of channel It is one of the following values e Merchant Non auction seller e eBayItem eBay auction xs string Optional The URL on the merchant site to redirect to after a successful giropay payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany xs string Optional The URL on the merchant site to redirect to after a successful giropay payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany xs string Optional The URL on the merchant site to transfer to after a bank transfer payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany ns BillingAgreementDetailsType Optional Billing agreement details ed EnhancedCheckoutDataType Optional Enhanced data for different industry segments This field is for eBay use only ns OtherPaymentMethodDetailsType Optional List of other payment methods with which the buyer can pay August 2012 SOAP API Developer Reference ExpressCheckout API Operations CN SetExpressCheckout API Operation Field Description BuyerDetails ns BuyerDetailsType Optional Details about the buyer s account BrandN
430. tusCodeType NOTE PendingReason is returned in the response only if PaymentStatus is Pending This field does not apply to capturing point of sale authorizations which do not create pending payments Reason the payment is pending It is one of the following values e none No pending reason e address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile e echeck The payment is pending because it was made by an eCheck that has not yet cleared e intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview e multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service SOAP API Developer Reference August 2012 39 NS Authorization and Capture API Operation Reference
431. type is Maestro you must set the currencyTd to GBP In addition you must specify either StartMonth and StartYear or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters CreditCardNumber xs string Optional Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type ExpMonth xs int Optional Credit card expiration month Character length and limitations 2 single byte numeric characters including leading Zero ExpYear xs int Optional Credit card expiration year Character length and limitations 4 single byte numeric characters Cvv2 xs string Optional Card Verification Value version 2 To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits CardOwner ns PayerInfoType Optional Details about the owner of the credit card StartMonth xs int Optional Month that Maestro card was issued Character length and limitations 2 digit zero filled if necessary SOAP API Developer Reference August 2012 263 264 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description
432. uction item number Character length 765 single byte characters xs string Optional Auction transaction identification number Character length 255 single byte characters xs string Optional Auction order identification number Character length 64 single byte characters AddressType Shipping Fields Field Description Name xs string Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters Street1 xs string First street address It is required if using a shipping address Character length and limitations 100 single byte characters Street2 xs string Optional Second street address Character length and limitations 100 single byte characters CityName xs string Name of city It is required if using a shipping address Character length and limitations 40 single byte characters StateOrProvince xs string State or province It is required if using a shipping address Character length and limitations 40 single byte characters PostalCode xs string U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters SOAP API Developer Reference August 2012 65 4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description Country ebl CountryCodeTyp
433. ue of ReferenceIDin the request is a billing agreement identification number ebl FMFDetailsType Fraud filter details xs string Response code from the processor when a recurring transaction is declined For details on the meanings of the codes see https merchant paypal com us cgi bin amp cmd render content amp content ID merchant cc compliance error codes This field is available since version 84 0 xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 PaymentinfoType Fields Field Description TransactionID xs string Unique transaction ID of the payment Character length and limitations 17 single byte characters 268 August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 DoReferenceTransaction API Operation Field Description ParentTransactionID xs string Parent or related transaction identification number This value in this field is for the following transaction types e Reversal Capture of an authorized transaction e Reversal Reauthorization of a transaction e Capture of
434. uest 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 396 August 2012 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 2
435. ugust 2012 117 118 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation AddressType Fields Field Description Name Streetl Street2 CityName StateOrProvince PostalCode Country Phone AddressStatus xs string Person s name associated with this shipping address Character length and limitations 32 single byte characters xs string First street address Character length and limitations 100 single byte characters xs string Second street address Character length and limitations 100 single byte characters xs string Name of city Character length and limitations 40 single byte characters xs string State or province Character length and limitations 40 single byte characters xs string U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters ebl CountryCodeType Country code Character length and limitations 2 single byte characters xs string Phone number Character length and limitations 20 single byte characters ebl AddressStatusTypeCode Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed PaymentDetailsType Fields When implementing parallel payments you can create up to 10 sets of payment details type parameter fields each representing one payment you are hosting on your marketplace August 2012 SOAP API Developer Reference Expres
436. ugust 2012 SOAP API Developer Reference Authorization and Capture API Operation Reference aa DoReauthorization API Operation DoReauthorization Request Fields Field Description AuthorizationID xs string Required Value of a previously authorized transaction identification number returned by PayPal Character length and limitations 19 single byte characters Amount ebl BasicAmountType Required Amount to reauthorize Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma DoReauthorization Response Message o AbstractResponse Type te AuthorizationInfoType Timestamp 0 1 dateTime e PaymentStatus PaymentStatusCodeType gt Ack AckCodeType gt PendingReason 0 1 PendingStatusCodeType e CorrelationID 0 1 string e ProtectionEligibility 0 1 string Errors 0 ErrorType ProtectionEligibilityType 0 1 string Version string Build string fe any DoReautnorizationResponse Type e AuthorizationID 1 1 string AuthorizationInfo 0 1 AuthorizationInfoType NOTE Not all fields shown are available for use Only use fields described in the documentation DoReauthorization Response Fields Field Description AuthorizationID xs string New authoriz
437. uled billing date in YYYY MM DD format NumberCycles xs int Completed The number of billing cycles completed in the current active subscription period A billing cycle is considered completed when payment is collected or after retry attempts to collect payment for the current billing cycle have failed NumberCycles xs int Remaining The number of billing cycles remaining in the current active subscription period SOAP API Developer Reference August 2012 213 214 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description OutstandingBalance cc BasicAmount Type The current past due or outstanding balance for this profile Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD FailedPaymentCount xs int The total number of failed billing cycles for this profile LastPaymentDate xs dateTime The date of the last successful payment received for this profile in YY Y Y MM DD format Last PaymentAmount cc BasicAmountType The amount of the last successful payment received for this profile Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optiona
438. umber which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 132 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description TaxTotal ebl BasicAmountType Optional Sum of tax for all items in this order NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma OrderDescription xs string Optional Description of items the buyer is purchasing NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged Character length and limitations 127 single byte alphanumeric characters Custom xs string Optional A free form field for your own use NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payment that is not
439. ument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details The transaction could not be loaded Internal Error OtherPaymentMethodID is missing OtherPaymentMethodLabel is missing OtherPaymentMethodType is missing One or more of these giropay URLs is missing giropaySuccessURL giropayCancelURL BanktxnPendingURL Transaction refused because of an invalid argument See additional error messages for details The transaction id is not valid Invalid value for request billing address parameter Invalid item URL OtherPaymentMethodType is invalid RegistrationDate of buyer is invalid SOAP API Developer Reference August 2012 303 304 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused because Invalid eBay buyer feedback overall of an invalid argument See positive count additional error messages for details 10004 Transaction refuse
440. unt supported for trial amount 11512 Invalid trial shipping Trial shipping amount must be gt If a trial shipping amount is amount supplied it must be gt 0 11513 Invalid currency for trial This currency is currently not Currency must be USD shipping amount supported for trial shipping amount 11514 Invalid profile status The profile status is invalid 11515 Invalid currency for trial tax This currency is currently not Currency must be USD amount supported for trial tax amount 11516 Invalid billing frequency Billing Frequency must be gt 0and The combination of billing be less than or equal to one year frequency and billing period cannot exceed one year 11517 Invalid total billing cycles Total billing cycles must be gt 0 0 means continuous 11518 Invalid billing period Billing period must be one of Day Week Month SemiMonth or Year 11519 Invalid amount Bill amount must be greater than 0 11520 Invalid currency for amount This currency is currently not Currency must be USD supported for amount 11521 Invalid shipping amount Shipping amount must be gt 0 11522 Invalid currency for This currency is currently not Currency must be USD shipping amount supported for shipping amount 11523 Invalid tax amount Tax amount must be gt 0 11524 Invalid currency for tax This currency is currently not Currency must be USD amount supported for tax amount 11531 Invalid profile status The profile status must be one of A ctive C ancelled or e X pi
441. untryCodeType e Name 0 1 string Street1 0 1 string Street2 0 1 string CityName 0 1 string StateOrProvince 0 string amp Country 0 1 CountryCodeType JE CountryName 0 1 string Phone 0 1 string PostalCode 0 1 string AddressID 0 1 string AddressOwner 0 1 AddressOwnerCodeType External ddressID 0 1 string InternationalName 0 1 string InternationalStateAndCity 0 1 string InternationalStreet 0 1 string e AddressStatus 0 1 AddressStatusCodeType NOTE Not all fields shown are available for use Use only the fields described in the documentation DoDirectPayment Request Fields Field Description PaymentAction ebl PaymentAct ionCodeType Optional How you want to obtain payment It is one of the following values e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Sale This is a final sale for which you are requesting payment default NOTE Order is not allowed for Direct Payment Character length and limit Up to 13 single byte alphabetic characters August 2012 SOAP API Developer Reference DoDirectPayment API Operation am DoDirectPayment Request Message Field Description CreditCard ebl CreditCardDetailsType Required Information about the credit card to be charged Paymen
442. urUAaTPCetails 0 1 string St AirlirieILi ierary 0 1 AirliietLirierarzType E SellerCetailsType E Seller d 70 1 string SellerUserNane 70 1 string SellerRegistrationDatz 70 1 dateTire PayPal amp ccountID 70 1 string Secur2MerchantAccountID 0 1 UserIDType E PaymentActionCodeType E OfferDeteilsType Offercode 0 17 string BMLO ferinfo U 1 BMLCfferinfolype NOTE Not all fields shown are available for use Use only the fields described in the documentation BMLOfferInfoType oes erTracking ul string e OfferTrackingID 0 1 stri E OfferDetailsType e OfferCode 0 1 string e BMLOfferInfo 0 1 BMLOfferInfoType NOTE Not all fields shown are available for use Use only the fields described in the documentation I BasicAmountType 8 currencyID CurrencyCodeType e Number 1 string i EbayItemPaymentDetailsItemType ItemMumber 0 1 string Quantity 1 integer e Tax 1 BasicAmountType AuctionTransactionId 0 1 string e OrderId 0 1 string e CartID 0 1 string Amount ki BasicAmountType e EbayltemPaymentDetailsltem 0 1 EbayItemPaymentDetailsItemType e PromoCode 1 string e ProductCategory 1 ProductCategoryType Description 41 string E ProductCategoryType ItemWeight T MeasureType ItemLength ul MeasureType fe MeasureType e Item
443. ust be a period and the optional thousands separator must be a comma cc BasicAmount Type Optional Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 CreateRecurringPaymentsProfile API Operation Field Description TaxAmount cc BasicAmount Type Optional Taxamount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ActivationDetailsType Fields Field Description InitialAmount cc BasicAmount Type Optional Initial non recurring payment amount due immediately upon profile creation Use an initial amount for enrolment or set up fees NOTE All amounts included in the request must have the same currency Character len
444. ustomer service number and PayPal s customer service number The maximum length of the total soft descriptor is 22 characters Of this the PayPal prefix uses either 4 or 8 characters shown in the data format Thus the maximum length of the soft descriptor passed in the API request is 22 len lt PP PAYPAL gt len lt Descriptor set in Payment Receiving Preferences gt 1 For example assume the following conditions e The PayPal prefix toggle is set to PAYPAL in PayPal s administration tools e The merchant descriptor set in the Payment Receiving Preferences is set to EBAY e The soft descriptor is passed in as JanesFlowerGifts LLC The resulting descriptor string on the credit card would be PAYPAL EBAY JanesFlow PaymentReason ns PaymentReasonType Indicates the type of transaction It is one of the following values e None Transaction is not identified as a particular type e Refund Identifies the transaction as a refund MsgSubId xs string Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 SOAP API Developer Reference August 2012 257 FE Recurring Payments and Re
445. ut xs string This field holds the category of the instrument only when it is promotional Return value 1 represents BML xs string Code used to identify the promotion offer xs string Unique identification for merchant buyer offer combo PaymentlnfoType Fields When implementing parallel payments up to 10 payment information type sets of payment information type parameter fields can be returned each representing one payment you are hosting on your marketplace 144 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN DoExpressCheckoutPayment API Operation Field Description TransactionID xs string Unique transaction ID of the payment Unique transaction ID of the payment You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Store this number for tracking the order It represents an order placeholder in the PayPal system for a subsequent authorization by UATP NOTE If the PaymentAction of the request was Authorization or Order this value is your Authorization ID for use with the Authorization amp Capture APIs Character length and limitations 19 single byte characters TransactionType ns PaymentTransact ionCodeType Type of transaction It is one of the following values Type of transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e cart e express checkout Character length
446. vrak ra krakk eee 377 What s New in Version 82 0 LL 22 22e 377 8 August 2012 SOAP API Developer Reference Contents E New Field in DoCapture Request 2 arva 00 rak ee 377 New MerchantStoreDetailsType in DoCapture Request 377 New Fields in RefundTransaction Request 0 ka aa 378 New MerchantStoreDetailsType in RefundTransaction Request 378 What s New in Version 80 0 ee 379 New Field in PaymentDetailsType in DoDirectPayment Request 379 New Fields in PaymentDetailsType in DoReferenceTransaction Request 379 What s New in Version 74 0 ee 380 New Behavior of DoExpressCheckoutPayment 2 a vr vr va vr ra ras 380 New DoExpressCheckoutPayment Error Code lll len 380 What s New in Version 72 0 2 22 380 Changes to BuyerDetailsType in SetExpressCheckout Request 380 New TaxlaDetailsType Structure in SetExpressCheckout Request 381 New TaxldDetailsType Structure in GetExpressCheckoutDetails Response 381 What s New in Version 69 222 lll les 382 New PaymentDetailsltemType Structure in CreateRecurringPaymentsProfile Request 382 Changes to PaymentDetailsltemType in DoReferenceTransaction Request 383 Whats New in Version 66 a sss 384 Changes to PaymentDetailsType in SetExpressCheckout and DoExpressCheckoutPayment Requests vr rv kn 384 Changes to PaymentDetail
447. wWidth 1 MeasureType ItemHeight vi MeasureType ItemURL 1 string te EnhancedItemDataType e EnhancedItemData 1 EnhancedItemDataType ItemCategory 1 ItemCategoryType E ItemCategoryType NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 85 86 ExpressCheckout API Operations SetExpressCheckout API Operation SetExpressCheckout Request Fields Field Description OrderTotal deprecated MaxAmount OrderDescription deprecated ebl BasicAmountType Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases If the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment set this field to 0 NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma
448. wers are displayed only if a valid survey question is present Character length and limitations 15 single byte characters ns TotalType Optional Enables display of Estimated Total instead of Total in the cart review area It is one of the following values e Total e EstimatedTotal Character length and limitations 14 single byte characters This field is available with API Version 64 0 or later xs string Optional Displays a note to buyers in the cart review area below the total amount Use the note to tell buyers about items in the cart such as your return policy or that the total excludes shipping and handling Character length and limitations 127 single byte characters This field is available with API Version 64 0 or later ns PaymentReasonType Indicates the type of transaction It is one of the following values e None Transaction is not identified as a particular type e Refund Identifies the transaction as a refund 94 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN SetExpressCheckout API Operation AddressType Fields Field Description Name xs string Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters Street1 xs string First street address It is required if using a shipping address Character length and limitations 100 single byte charact
449. xmlns urn ebay api PayPalAPI xsi type ebl CustomSecurityHeaderType gt lt Credentials xmlns urn ebay apis eBLBaseComponents xsi type ebl UserIdPasswordType gt lt RequesterCredentials gt lt SOAP ENV Header gt lt SOAP ENV Body id 0 gt specific api name Response xmlns urn ebay api PayPalAPI gt Timestamp xmlns urn ebay api PayPalAPI gt dateTime in UTC GMT lt TIMESTAMP gt Ack xmlns urn ebay apis eBLBaseComponents gt Success lt Ack gt Version xmlns urn ebay apis eBLBaseComponents gt serviceVersion lt Version gt CorrelationId xmlns urn ebay apis eBLBaseComponents gt SOAP API Developer Reference August 2012 21 22 PayPal SOAP API Basics Error Responses applicationCorrelation lt CorrelationID gt Build xmlns urn ebay apis eBLBaseComponents gt api build number lt Build gt lt elements for specific api response gt data lt elements for specific api response gt specific api name Response gt lt SOAP ENV Body SOAP ENV Envelope Annotation of Generic SOAP Response Lines Comment 22 and 31 The specific api name Response start and end elements 23 Each API response contains a timestamp with its date and time in UTC GMT 24 The lt Ack gt element contains the string Success after the corresponding request has been successfully processed In the case of errors Ack is set to a value other than Success and
450. xs string Optional Your URL for receiving Instant Payment Notification IPN about this transaction If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists IMPORTANT The notify URL applies only to DOExXpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters ns AddressType Optional Address to which the order is shipped ebl PaymentDetailsItemType Optional Details about each individual item included in the order ed EnhancedPaymentDataType Optional Enhanced Data section to accept channel specific data eBay xs string Optional Note to the merchant Character length and limitations 255 single byte characters ns SellerDetailsType Optional Details about the merchant This information is used for emails sent out for eBay transactions xs string Optional Transaction identification number of the transaction that was created NOTE This field is only returned after a successful transaction for DoExpressCheckout has occurred xs string Optional The payment method type Specify the value InstantPaymentOnly August 2012 SOAP API Developer Reference ExpressCheckout API Operations CEN SetExpressCheckout API Operation Field Description PaymentAction ebl PaymentAct ionCodeType How you want to obtain payment When
451. xs string Display name of the buyer TransactionID xs string Merchant s transaction ID Status xs string The status of the transaction GrossAmount ebl BasicAmountType The total gross amount charged including any profile shipping cost and taxes FeeAmount ebl BasicAmountType The fee that PayPal charged for the transaction NetAmount ebl BasicAmountType The net amount of the transaction 286 August 2012 SOAP API Developer Reference API Error Codes The PayPal API can return multiple errors for any operation General API Errors General API Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication Authoriza Username Password is incorrect This error can be caused by an incorrect tion Failed API username an incorrect API password or an invalid API signature Make sure that all three of these values are correct For your security PayPal does not report exactly which of these three values might be in error 10002 Authentication Authoriza You do not have permission to tion Failed make this API call 10002 Authentication Authoriza Account is locked or inactive tion Failed 10002 Internal Error Internal Error 10002 Authentication Authoriza Internal Error tion Failed 10002 Authentication Authoriza Account is not verified tion Failed 10002 Authentication Authoriza This call is not defined in the tion Failed database 10002 Authentication Authoriza Token is not valid tion Failed 1
452. y codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma ebl BasicAmountType Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if you offer insurance options NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma InsuranceTotal is available since version 53 0 August 2012 SOAP API Developer Reference ExpressCheckout API Operations CIEN SetExpressCheckout API Operation Field Description ShippingDiscount ebl BasicAmount Type Optional Shipping discount for this order specified as a negative number NOTE You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes
453. yPal APIs are based on two core structures AbstractRequestType and AbstractResponseType 18 August 2012 SOAP API Developer Reference PayPal SOAP API Basics Request Structure Diagram of SOAP Request Envelope SOAP Request Envelope eBL RequesterCredentials API user id lt Username gt API user password lt Password gt API Signature lt Signature gt Third party Authorization lt Subtect gt eBL Payload elements specific to particular PayPal API Request Structure The following annotated description of the SOAP request structure shows the elements required by the PayPal SOAP API General Structure of PayPal API SOAP Request lt xml version 1 0 encoding UTF 8 gt SOAP ENV Envelope xmlns xsi http www w3 org 2001 XMLSchema instance xmlns SOAP ENC http schemas xmlsoap org soap encoding xmlns SOAP ENV http schemas xmlsoap org soap envelope xmlns xsd http www w3 0rg 2001 XMLSchema SOAP ENV encodingStyle http schemas xmlsoap org soap encoding gt lt SOAP ENV Header gt RequesterCredentials xmlns urn ebay api PayPalAPI gt Credentials xmlns urn ebay apis eBLBaseComponents gt SOAP API Developer Reference August 2012 19 Dus PayPal SOAP API Basics Request Structure lt Username gt api username lt Username gt lt Password gt api password lt Password gt lt Signature gt lt Subject gt lt Credentials gt lt RequesterCredentials gt lt S
454. yPal generates and gives to the subscriber to access the subscription Character length and limitations 64 alphanumeric single byte characters xs string Password that PayPal generates and gives to the subscriber to access the subscription For security the value of the password is hashed Character length and limitations 128 alphanumeric single byte characters xs string The number of payment installments that occur at the regular rate Character length and limitations No limit xs string Indicates whether reattempts should occur upon payment failures xs string Indicates whether regular rate recurs It is one of the following values e 1 Yes ns SubscriptionTermsType Subscription terms SubscriptionTermsType Fields Field Description Amount eb BasicAmount Type Amount subscriber is to be charged in 1 payment Character length and limitations No limit Period xs string Period of time that the subscriber is charged Character length and limitations No limit SOAP API Developer Reference August 2012 181 EI GetTransactionDetails API Operation GetTransactionDetails Response Message 182 August 2012 SOAP API Developer Reference ManagePendingTransactionStatus API Operation The ManagePendingTransactionStatus API operation accepts or denys a pending transaction held by Fraud Management Filters ManagePendingTransactionStatus Request Message fe AbstractRequestType Transactiontd Detaill
455. yment PendingFilters xs RiskFilterListType List of filters that caused the payment to become pending ReportsFilters xs RiskFilterListType List of filters that caused the payment to become flagged SOAP API Developer Reference August 2012 273 274 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation RiskFilterListType Fields Field Description ID Name Description XS int Filter ID It is one of the following values XS 1 AVS No Match 2 AVS Partial Match 3 AVS Unavailable Unsupported 4 Card Security Code CSC Mismatch 5 Maximum Transaction Amount 6 Unconfirmed Address 7 Country Monitor 8 Large Order Number 9 Billing Shipping Address Mismatch 10 Risky ZIP Code 11 Suspected Freight Forwarder Check 12 Total Purchase Price Minimum 13 IP Address Velocity 14 Risky Email Address Domain Check 15 Risky Bank Identification Number BIN Check 16 Risky IP Address Range 17 PayPal Fraud Model string Filter name XS string Filter description August 2012 SOAP API Developer Reference RefundTransaction API Operation The RefundTransaction API operation issues a refund to the PayPal account holder associated with a transaction RefundTransaction Request Message 2 AbstractRequestType Transactionid e DetailLevel 0 DetailLevelCodeType e ErrorLanguage 0
456. yments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy xs string Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is introduced in API version 64 4 xs string Storeld as entered in the transaction xs string Terminalld as entered in the transaction PaymentlteminfoType Fields Field Description InvoiceID xs string Invoice number you set in the original transaction Character length and limitations 256 single byte alphanumeric characters Custom xs string Custom field you set in the original transaction Character length and limitations 127 single byte alphanumeric characters Memo xs string Memo entered by your customer in PayPal Website Payments note field Character length and limitations 255 single byte alphanumeric characters SalesTax xs string Amount of tax char
457. you which field is invalid 10703 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address2 in the billing address message tells you which field is invalid 10704 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city in the billing address message tells you which field is invalid 10705 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error state in the billing address message tells you which field is invalid 10706 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error postal code in the billing address message tells you which field is invalid 10707 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid country in the billing address field in the address The long error message tells you which field is invalid August 2012 SOAP API Developer Reference API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10708 Invalid Data 10709 Invalid Data 10709 Invalid Data 10710 Invalid Data 10710 Invalid Data 10711 Invalid Data
458. ype BasicAmountType BasicAmountType BasicAmountType BasicAmountType string string string string string AddressType ShippingServiceCodeType dateTime PaymentDetailsItemType BasicAmountType BasicAmountType string AllowedPaymentMethodType EnhancedPaymentDataType SellerDetailsType string string PaymentActionCodeType string string string OfferDetailsType E UserSelectedOptionType ShippingCalculationMode 0 1 InsuranceOptionSelected 0 1 ShippingOptionIsDefault 0 1 E ShippingOptionAmount 0 1 ShippingOptionName 0 1 string string string BasicAmountType string E IncentiveDetailsType Uniqueldentifier SiteAppliedon TotalDiscountAmount Status ErrorCode IncentiveAppliedDetails 0 E PaymentRequestInfoType E TransactionId string IncentiveSiteAppliedOnType BasicAmountType IncentiveAppliedStatusType integer IncentiveAppliedDetailsType 0 1 string e PaymentRequestID 0 1 string PaymentError 0 1 ErrorType E ExternalRememberMeStatusDetailsType ExternalRememberMeStatus 1 1 integer ExternalRememberMeID 0 1 string NOTE Not all fields shown are available for use Use only the fields described in the documentation SOAP API Developer Reference August 2012 109 110 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation lo lo loj e e e
459. ype Type of billing agreement BillingAgreement xs string Description Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement Character length and limitations 127 single byte alphanumeric characters August 2012 SOAP API Developer Reference Recurring Payments and Reference Transactions API Operations 12 BAUpdate API Operation Field Description BillingAgreement xs string Custom Custom annotation field for your own use Character length and limitations 256 single byte alphanumeric characters BillingAgreementSta ebl MerchantPullStatusCodeType tus Optional Use to cancel a billing agreement To cancel a billing agreement pass the value Canceled NOTE If you do not pass the value Canceled BAUpdate returns the buyer s latest billing address BillingAgreementMax cc BasicAmountType Maximum amount for this billing agreement NOTE This field only has a value if the buyer signed up for PayPal using Preapproved Payments it is included for backwards compatibility with legacy systems Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma PayerInfo ns PayerInfoType Information about the buyer such as the buyer s
460. yte characters StateOrProvince xs string State or province Required for U S addresses only Character length and limitations 40 single byte characters PostalCode xs string U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters Country ns CountryCode Country code Character length and limitations 2 single byte characters CountryName xs string Expanded name of country Character length and limitations 64 single byte alphanumeric characters Phone xs string Phone number Character length and limitations 20 single byte characters PaymentinfoType Fields Field Description TransactionID xs string Unique transaction ID of the payment Character length and limitations 17 single byte characters SOAP API Developer Reference August 2012 173 pg GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description ParentTransactionID ReceiptID TransactionType PaymentType PaymentDate GrossAmount xs string Parent or related transaction identification number This value in this field is for the following transaction types e Reversal Capture of an authorized transaction e Reversal Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionlD is the original OrderID e Capture of an o

Download Pdf Manuals

Related Search

Related Contents

Guide d`installation  Atomic 3000 - Spectaculaires  Table of Contents  Motore per porte garage sezionali Operator for sectional  Sony CD-R 80min-700MB 48x (100)  Cahier des charges - L`ADEME en Poitou  Lynx™L-3 & Lynx L-4  360 Systems MIDI Bass Pro  Benutzerhandbuch PocketBook 360° Plus  KitchenAid 2225409 Refrigerator User Manual  

Copyright © All rights reserved. Failed to retrieve file