2013

ManualsBrandsPayPal ManualsApplicationsSOAP API Developer

Table Of Contents

SOAP API Developer Reference

SOAP API Developer

Reference

Last updated: February 01, 2013

Summary of content (410 pages)

PAGE 1
SOAP API Developer Reference Last updated: February 01, 2013
PAGE 2
SOAP API Developer Reference Document Number: 100002.en_US-201302 © 2013 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 © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A.
PAGE 3
Contents What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Where to Go for More Information . . . . . . . . . . .
PAGE 4
Contents Chapter 3 Authorization and Capture API Operation Reference . . . . 31 DoCapture API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 DoCapture Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 DoCapture Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 DoAuthorization API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 DoAuthorization Request Message . . . . . . . . . . . . . . .
PAGE 5
Contents AddressType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 DoNonReferencedCredit Response Message . . . . . . . . . . . . . . . . . . . . . . . . 78 DoNonReferencedCredit Response Fields . . . . . . . . . . . . . . . . . . . . . . . 78 Chapter 6 ExpressCheckout API Operations . . . . . . . . . . . . . . 79 SetExpressCheckout API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 SetExpressCheckout Request Message . . . . . . . . . . . . . . .
PAGE 6
Contents PaymentItemInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176 PaymentItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177 AuctionInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178 SubscriptionInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178 SubscriptionTermsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 7
Contents CreateBillingAgreement API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . .236 CreateBillingAgreement Request Message . . . . . . . . . . . . . . . . . . . . . . .236 CreateBillingAgreement API Response Message . . . . . . . . . . . . . . . . . . . .237 GetBillingAgreementCustomerDetails API Operation . . . . . . . . . . . . . . . . . . . .238 GetBillingAgreementCustomerDetails Request Message . . . . . . . . . . . . . . . .238 GetBillingAgreementCustomerDetails Response Message . .
PAGE 8
Contents TransactionSearch API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333 RefundTransaction API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334 MassPay API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .338 Recurring Payments Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .341 SetCustomerBillingAgreement Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 9
Contents New RefundInfoType in RefundTransaction Response . . . . . . . . . . . . . . . . .386 New Field in DoReferenceTransactionResponseDetailsType . . . . . . . . . . . . .387 New Field in DoDirectPaymentResponse . . . . . . . . . . . . . . . . . . . . . . . .387 What’s New in Version 82.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387 New Field in DoCapture Request . . . . . . . . . . . . . . . . . . . . . . . . . . . .387 New MerchantStoreDetailsType in DoCapture Request . . .
PAGE 10
Contents 10 February 01, 2013 SOAP API Developer Reference
PAGE 11
What’s New What’s New Maintenance release. See the latest version of the PayPal Merchant API Release Notes for more information: https://www.x.
PAGE 12
What’s New 12 February 01, 2013 SOAP API Developer Reference
PAGE 13
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.
PAGE 14
Documentation Feedback 14 February 01, 2013 SOAP API Developer Reference
PAGE 15
1 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.
PAGE 16
1 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.
PAGE 17
PayPal SOAP API Basics Security 1 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.
PAGE 18
1 PayPal SOAP API Basics SOAP Service Endpoints RequesterCredentials Authentication Elements in SOAP Header Element Value Description 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 > API Certificate Information.
PAGE 19
PayPal SOAP API Basics Request Structure 1 Diagram of SOAP Request Envelope 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
PAGE 20
1 PayPal SOAP API Basics Request Structure api_password service_version data
PAGE 21
PayPal SOAP API Basics SOAP Message Style: doc-literal 1 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:
PAGE 22
1 PayPal SOAP API Basics Error Responses applicationCorrelation api_build_number data 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.
PAGE 23
PayPal SOAP API Basics Error Responses 1 The most important of these additional elements are as follows:  ShortMessage  LongMessage  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.
PAGE 24
1 PayPal SOAP API Basics CorrelationID for Reporting Problems to PayPal debugging_info 1.000000 1.0006.. other elements in response.
PAGE 25
PayPal SOAP API Basics Core Currency Amount Data Type 1 3. The decimal separator must be a period (“.”). 4. You must not use any thousands separator. 5. BasicAmountType has a data type of ebl: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.
PAGE 26
1 26 PayPal SOAP API Basics Core Currency Amount Data Type February 01, 2013 SOAP API Developer Reference
PAGE 27
2 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 NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. AddressVerifyRequest Fields Field Description Email ebl:EmailAddressType (Required) Email address of a PayPal member to verify.
PAGE 28
2 AddressVerify API Operation AddressVerify 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.
PAGE 29
AddressVerify API Operation AddressVerify Response Message 2 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:  None – The request value of the Email 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.
PAGE 30
2 30 AddressVerify API Operation AddressVerify Response Message February 01, 2013 SOAP API Developer Reference
PAGE 31
3 Authorization and Capture API Operation Reference The Authorization and Capture API operations describe the PayPal API operations related to delayed payment settlement: DoCapture API Operation Captures an authorized payment. DoCapture Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 32
3 Authorization and Capture API Operation Reference DoCapture API Operation DoCapture Request Fields Field Description AuthorizationID xs:string (Required) Authorization identification number of the payment you want to capture. This is the transaction ID returned from DoExpressCheckoutPayment, DoDirectPayment, or CheckOut. For point-of-sale transactions, this is the transaction ID returned by the CheckOut call when the payment action is Authorization.
PAGE 33
Authorization and Capture API Operation Reference 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.
PAGE 34
3 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.
PAGE 35
Authorization and Capture API Operation Reference DoCapture API Operation NOT E : 3 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 PaymentInfo ebl:PaymentInfoType Information about the payment.
PAGE 36
3 Authorization and Capture API Operation Reference DoCapture 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.
PAGE 37
Authorization and Capture API Operation Reference DoCapture API Operation Field Description PaymentType ebl:PaymentCodeType Indicates whether the payment is instant or delayed. It is one of the following values:  none  echeck  instant 3 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:BasicAmountType The final amount charged, including any shipping and taxes from your Merchant Profile.
PAGE 38
3 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:            38 In a successful DoCapture response for a point-of-sale authorization, the only value value is Completed. None – No status Canceled-Reversal – This means a reversal has been canceled.
PAGE 39
Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description PendingReason ebl:PendingStatusCodeType NOTE: 3 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:  none: – No pending reason.
PAGE 40
3 Authorization and Capture API Operation Reference DoAuthorization API Operation DoAuthorization Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. DoAuthorization Request Fields 40 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.
PAGE 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.
PAGE 42
3 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.
PAGE 43
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:  none – No pending reason.  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.
PAGE 44
3 Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description ProtectionEligibility Type xs:string Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values:  Eligible – Merchant is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received.  ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
PAGE 45
Authorization and Capture API Operation Reference DoReauthorization 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. Exmples of this include requests due to timeouts or errors during the original request. Character length and limitations: 38 single-byte characters This field is available since version 94.0.
PAGE 46
3 Authorization and Capture API Operation Reference DoReauthorization API Operation AuthorizationInfo Fields 46 Field Description PaymentStatus ebl:PaymentStatusCodeType Status of the payment. It is one of the following values:  None – No status.  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.
PAGE 47
Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description PendingReason ebl:PendingStatusCodeType Reason the payment is pending. It is one of the following values:  none – No pending reason.  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.
PAGE 48
3 Authorization and Capture API Operation Reference DoVoid API Operation Field Description ProtectionEligibility Type xs:string Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values:  Eligible – Merchant is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received.  ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
PAGE 49
Authorization and Capture API Operation Reference DoVoid API Operation Field Description 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 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.
PAGE 50
3 50 Authorization and Capture API Operation Reference DoVoid API Operation February 01, 2013 SOAP API Developer Reference
PAGE 51
4 DoDirectPayment API Operation The DoDirectPayment API Operation enables you to process a credit card payment. DoDirectPayment Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 52
4 DoDirectPayment API Operation DoDirectPayment Request Message NOT E : 52 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 53
DoDirectPayment API Operation DoDirectPayment Request Message SOAP API Developer Reference February 01, 2013 4 53
PAGE 54
4 54 DoDirectPayment API Operation DoDirectPayment Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 55
DoDirectPayment API Operation DoDirectPayment Request Message NOT E : 4 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 56
4 DoDirectPayment API Operation DoDirectPayment Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. DoDirectPayment Request Fields Field Description PaymentAction ebl:PaymentActionCodeType (Optional) How you want to obtain payment. It is one of the following values:  Authorization – This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
PAGE 57
DoDirectPayment API Operation DoDirectPayment Request Message Field Description CreditCard ebl:CreditCardDetailsType (Required) Information about the credit card to be charged. PaymentDetails ebl:PaymentDetailsType (Required) Information about the credit card to be charged. IPAddress xs:string (Required) IP address of the buyer’s browser. NOTE: 4 PayPal records this IP addresses as a means to detect possible fraud.
PAGE 58
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:  Visa  MasterCard  Discover  Amex  Maestro: See note. NOTE: If the credit card type is Maestro, you must set currencyId to GBP.
PAGE 59
DoDirectPayment API Operation 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 4 PayerInfoType Fields Field Description Payer ebl:EmailAddressType (Required) Email address of buyer.
PAGE 60
4 DoDirectPayment API Operation DoDirectPayment Request Message PayerNameType Fields Field Description Salutation xs:string (Optional)Buyer's salutation. Character length and limitations: 20 single-byte characters FirstName ebl:PersonNameType (Required)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 (Required)Buyer's last name.
PAGE 61
DoDirectPayment API Operation DoDirectPayment Request Message Field Description 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 4 PaymentDetailsType Fields Field Description OrderTotal ebl:BasicAmountType (Required) The total cost of the transaction to the buyer.
PAGE 62
4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description InsuranceTotal ebl:BasicAmountType (Optional) Total shipping insurance costs for this order. The value must be a nonnegative 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.
PAGE 63
DoDirectPayment API Operation DoDirectPayment Request Message Field Description Custom xs:string (Optional) A free-form field for your own use. NOTE: 4 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.
PAGE 64
4 DoDirectPayment API Operation DoDirectPayment Request Message PaymentDetailsItemType 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 (Optional) Cost of item.
PAGE 65
DoDirectPayment API Operation DoDirectPayment Request Message 4 EbayItemPaymentDetailsItemType Fields Field Description ItemNumber xs:string (Optional) Auction item number. Character length: 765 single-byte characters AuctionTransaction Id xs:string (Optional) Auction transaction identification number. Character length: 255 single-byte characters OrderID xs:string (Optional) Auction order identification number.
PAGE 66
4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description 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 ThreeDSecureRequest Fields (U.K. Merchants Only) 66 Field Description AuthStatus3ds xs:string (Optional) A value returned by the Cardinal Centinel.
PAGE 67
DoDirectPayment API Operation DoDirectPayment Response Message 4 DoDirectPayment Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 68
4 DoDirectPayment API Operation DoDirectPayment Response Message DoDirectPayment Response Fields Field Description TransactionID xs:string Unique transaction ID of the payment. N O TE : If the PaymentAction of the request was Authorization, the value of TransactionID is your AuthorizationID for use with the Authorization and Capture APIs.
PAGE 69
DoDirectPayment API Operation DoDirectPayment Response Message Field Description 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. 4 RiskFilterListType Fields Field Description ID xs:int Filter ID.
PAGE 70
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.
PAGE 71
5 DoNonReferencedCredit API Operation The DoNonReferencedCredit API issues a credit to a card not referenced by the original transaction. DoNonReferencedCredit Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 72
5 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message NOT E : 72 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 73
DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message NOT E : 5 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.
PAGE 74
5 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description NetAmount ns:BasicAmountType (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 (,).
PAGE 75
DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message 5 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:  Visa  MasterCard  Discover  Amex  Maestro: See note.
PAGE 76
5 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 xs:string (Optional)Buyer's salutation.
PAGE 77
DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description FirstName ns:PersonNameType (Conditional) Buyer’s first name is required except when the reference transaction is run against a billing agreement. In the case of a billing agreement, the first name field should not be used.
PAGE 78
5 DoNonReferencedCredit API Operation DoNonReferencedCredit Response Message DoNonReferencedCredit Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. DoNonReferencedCredit Response Fields 78 Field Description TransactionID ns:TransactionId Unique identifier of a transaction.
PAGE 79
6 ExpressCheckout API Operations Express Checkout API operations include SetExpressCheckout, GetExpressCheckoutDetails, and DoExpressCheckoutPayment. SetExpressCheckout API Operation The SetExpressCheckout API operation initiates an Express Checkout transaction.
PAGE 80
6 ExpressCheckout API Operations SetExpressCheckout API Operation NOT E : 80 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 81
ExpressCheckout API Operations SetExpressCheckout API Operation NOT E : 6 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 82
6 82 ExpressCheckout API Operations SetExpressCheckout API Operation February 01, 2013 SOAP API Developer Reference
PAGE 83
ExpressCheckout API Operations SetExpressCheckout API Operation SOAP API Developer Reference February 01, 2013 6 83
PAGE 84
6 84 ExpressCheckout API Operations SetExpressCheckout API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 85
ExpressCheckout API Operations SetExpressCheckout API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 86
6 ExpressCheckout API Operations SetExpressCheckout API Operation SetExpressCheckout Request Fields Field Description OrderTotal (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.
PAGE 87
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Custom (deprecated) 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.
PAGE 88
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Address (deprecated) 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.
PAGE 89
ExpressCheckout API Operations 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:  0 – The PayPal pages should not display the shipping address.
PAGE 90
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LocaleCode xs:string (Optional) Locale of pages displayed by PayPal during Express Checkout.
PAGE 91
ExpressCheckout API Operations 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 stored on a secure (https) server. If you do not specify an image, the business name displays.
PAGE 92
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description SolutionType ebl:SolutionTypeType (Optional) Type of checkout flow. It is one of the following values:  Sole – Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.  Mark – Buyer must have a PayPal account to check out. NOTE: LandingPage ebl:LandingPageType (Optional) Type of PayPal page to display.
PAGE 93
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BuyerDetails ns:BuyerDetailsType (Optional) Details about the buyer's account. BrandName 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 s ns:FundingSourceDetailsType (Optional) Funding source preferences.
PAGE 94
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BuyerEmailOptinEnab le 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:  0 – Do not enable buyer to provide email address.  1 – Enable the buyer to provide email address. SurveyQuestion xs:string (Optional) Text for the survey question on the PayPal pages.
PAGE 95
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description 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.
PAGE 96
6 ExpressCheckout API Operations SetExpressCheckout API Operation 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 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.
PAGE 97
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description InsuranceOptionOffer ed 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:  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.  false – The Insurance option displays ‘No.
PAGE 98
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description 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.
PAGE 99
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PaymentAction ebl:PaymentActionCodeType How you want to obtain payment. When 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.
PAGE 100
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Number xs:string (Optional) Item number. Character length and limitations: 127 single-byte characters This field is introduced in version 53.0. Quantity 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.
PAGE 101
ExpressCheckout API Operations SetExpressCheckout API Operation 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:  Digital  Physical 6 This field is available since version 65.1.
PAGE 102
6 ExpressCheckout API Operations SetExpressCheckout API Operation BuyerDetailsType Fields Field Description BuyerId xs:string (Optional) The unique identifier provided by eBay for this buyer. The value may or may not be the same as the username. In the case of eBay, it is different. Character length and limitations: 255 single-byte characters BuyerUserName xs:string (Optional) The user name of the user at the marketplaces site.
PAGE 103
ExpressCheckout API Operations SetExpressCheckout API Operation 6 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:  true – This is the default flat-rate shipping option. PayPal displays this option and its amount by default.  false – This flat-rate shipping option and its amount are not displayed as the default.
PAGE 104
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BillingAgreement Description xs:string 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”.
PAGE 105
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 SetExpressCheckout Response Message NOT E : Not all fields shown are available for use. Only use 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.
PAGE 106
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation GetExpressCheckoutDetails Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetExpressCheckoutDetails Request Fields 106 Field Description Token xs:string (Required) A timestamped token, the value of which was returned by SetExpressCheckout response.
PAGE 107
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 GetExpressCheckoutDetails Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 108
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : 108 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 109
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : 6 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 110
6 110 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation February 01, 2013 SOAP API Developer Reference
PAGE 111
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 112
6 112 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 113
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : 6 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 114
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetExpressCheckoutDetails Response Fields 114 Field Description Token xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.
PAGE 115
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description ContactPhone xs:string Buyer’s contact phone number. N O TE : 6 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.
PAGE 116
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description GiftReceiptEnable xs:string Whether the buyer requested a gift receipt. It is one of the following values:  true – The buyer requested a gift receipt.  false – The buyer did not request a gift receipt. GiftWrapName xs:string Returns the gift wrap name only if the buyer selects gift option on the PayPal pages.
PAGE 117
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PayerStatus ebl:PayPalUserStatusCodeType Status of buyer. It is one of the following values:  verified  unverified 6 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 two-character country codes.
PAGE 118
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation AddressType Fields Field Description Name xs:string Person’s name associated with this shipping address. Character length and limitations: 32 single-byte characters Street1 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.
PAGE 119
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 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. 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.
PAGE 120
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description InsuranceTotal 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.
PAGE 121
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description TaxTotal ebl:BasicAmountType (Optional) Sum of tax for all items in this order. NOTE: 6 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.
PAGE 122
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description FulfillmentAddress ns:AddressType (Optional) The address of the third-party shipping or fulfillment center ShipToAddress ns:AddressType Address the order is shipped to. PaymentDetailsItem ebl:PaymentDetailsItemType Details about each individual item included in the order. EnhancedPaymentData ed:EnhancedPaymentDataType Enhanced Data section to accept channel-specific data.
PAGE 123
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description Amount ebl:BasicAmountType Cost of item. NOT E : 6 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 (.
PAGE 124
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description ItemCategory ns:ItemCategoryType Indicates whether the item is digital or physical. For digital goods (ItemCategory=Digital), this field is required. It is one of the following values:  Digital  Physical This field is available since version 65.1. EbayItemPaymentDetailsItemType Fields Field Description ItemNumber xs:string Auction item number.
PAGE 125
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description ShippingOptionIsDefa ult xs:boolean Indicates whether the buyer chose the default shipping option. It is one of the following values:  true – The buyer chose the default shipping option.  false – The buyer did not choose the default shipping option. 6 Character length and limitations: true or false ShippingOptionAmount ebl:BasicAmountType The shipping amount that the buyer chose.
PAGE 126
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 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. TaxIdDetailsType Fields Field Description TaxIdType xs:string Buyer’s tax ID type.
PAGE 127
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 DoExpressCheckoutPayment Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 128
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 128 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 129
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 6 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.
PAGE 130
6 ExpressCheckout API Operations 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.
PAGE 131
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SurveyQuestion xs:string (Optional) Survey question on the PayPal pages. Limitations: 50 single-byte characters SurveyChoiceSelecte d xs:string (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.
PAGE 132
6 ExpressCheckout API Operations 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, each representing one payment you are hosting on your marketplace. Field Description OrderTotal ebl:BasicAmountType (Required) The total cost of the transaction to the buyer.
PAGE 133
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ShippingTotal ebl:BasicAmountType (Optional) Total shipping costs for this order. N O TE : 6 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.
PAGE 134
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description TaxTotal ebl:BasicAmountType (Optional) Sum of tax for all items in this order. N O TE : 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.
PAGE 135
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description 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. I MP O R TAN T : 6 The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
PAGE 136
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PaymentAction ebl:PaymentActionCodeType How you want to obtain payment. When 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.
PAGE 137
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description Amount ebl:BasicAmountType Cost of item. This field is required when you pass a value for ItemCategory. NOT E : 6 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.
PAGE 138
6 ExpressCheckout API Operations 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 DetailsItem eBl:ebayItemPaymentDetailsItemType (Optional) Information relating to an auction sale on eBay.
PAGE 139
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 UserSelectedOptions Fields Field Description InsuranceOptionSelec ted xs:boolean (Optional) The option that the buyer chose for insurance. It is one of the following values:  Yes – The buyer opted for insurance.  No – The buyer did not opt for insurance. ShippingOptionIsDefa ult xs:boolean (Optional) Whether the buyer chose the default shipping option.
PAGE 140
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation DoExpressCheckoutPayment Response Message NOT E : 140 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 141
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 6 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 142
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 142 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 143
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. 6 DoExpressCheckoutPayment Response Fields Field Description Token xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.
PAGE 144
6 144 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SuccessPageRedirect Requested xs:boolean Flag to indicate whether you would like to redirect the buyer to sign up for PayPal after completing the transaction. If set to true, you can redirect users to the following URL with the token value appended:: https://www.paypal.
PAGE 145
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ParentTransactionID ns:TransactionId Parent or related transaction identification number. This field is populated for the following transaction types:  Reversal  Capture of an authorized transaction  Reauthorization of a transaction  Capture of an order. The value of ParentTransactionID is the original OrderID.  Authorization of an order. The value of ParentTransactionID is the original OrderID.
PAGE 146
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description TransactionType ns:PaymentTransactionCodeType Type of transaction. It is one of the following values:  cart  express-checkout Character length and limitations: 15 single-byte characters PaymentType ebl:PaymentCodeType Indicates whether the payment is instant or delayed.
PAGE 147
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description 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 buyer’s account.
PAGE 148
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PendingReason ebl:PendingStatusCodeType 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.
PAGE 149
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description HoldDecision xs:string Reason that this payment is being held. It is one of the following values:  newsellerpaymenthold – This is a new merchant.  paymenthold – A hold is placed on the merchant’s transaction for a reason not listed. 6 This field is available since version 71.0 and is returned only if PaymentStatus is Completed-Funds-Held. ProtectionEligibili ty xs:string Prior to version 64.
PAGE 150
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description 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. UserSelectedOptions Fields Field Description ShippingCalculationM ode xs:string Describes how the options that were presented to the buyer were determined.
PAGE 151
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. 6 SellerDetailsType Fields Field Description PayPalAccountID xs:string Unique identifier for the merchant.
PAGE 152
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation RiskFilterListType Fields 152 Field Description ID xs:int Filter ID.
PAGE 153
7 GetBalance API Operation The GetBalance API Operation obtains the available balance for a PayPal account. GetBalance Request Message NOT E : Not all fields shown are available for use. Use only the fields described 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:  0 – Return only the balance for the primary currency holding.
PAGE 154
7 GetBalance API Operation GetBalance Response Message GetBalance Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetBalance Response Fields 154 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.
PAGE 155
8 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 NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 156
8 GetPalDetails API Operation GetPalDetails Response Message GetPalDetails Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetPalDetails Response Fields 156 Field Description Pal xs:string PayPal-assigned merchant account number.
PAGE 157
GetPalDetails API Operation GetPalDetails Response Message Field Description Locale xs:string Country code representing the merchant’s default locale.
PAGE 158
8 158 GetPalDetails API Operation GetPalDetails Response Message February 01, 2013 SOAP API Developer Reference
PAGE 159
9 GetTransactionDetails API Operation The GetTransactionDetails API operation obtains information about a specific transaction. GetTransactionDetails Request Message NOT E : 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.
PAGE 160
9 GetTransactionDetails API Operation GetTransactionDetails Response Message GetTransactionDetails Response Message 160 NOT E : 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. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 161
GetTransactionDetails API Operation GetTransactionDetails Response Message SOAP API Developer Reference February 01, 2013 9 161
PAGE 162
9 GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : 162 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 163
GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : 9 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 164
9 GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : 164 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 165
GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : 9 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 166
9 GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetTransactionDetails Response Fields 166 Field Description PaymentTransaction Details Wrapper structure.
PAGE 167
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description InsuranceOptionSele cted xs:boolean Whether the buyer selected the insurance option. It is one of the following values:  true – The buyer selected Yes for the insurance option.  false – The buyer did not select the insurance option. The option is No. 9 The value true is returned if the buyer selected the option. Otherwise false is returned.
PAGE 168
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description GiftWrapAmount 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 (,).
PAGE 169
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PaymentItemInfo ebl:PaymentItemInfoType Information about the payment item, such as the sales tax, the invoice number, and whether the buyer left a note to the merchant. SecondaryAddress ns:AddressType Information about the buyer's address in cases where the primary address is that of a shipping center. This field is introduced in API version 93.0.
PAGE 170
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description 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.
PAGE 171
GetTransactionDetails API Operation GetTransactionDetails Response Message 9 AddressType Fields Field Description AddressOwner ebl:AddressOwnerTypeCode eBay company that maintains this address. It is one of the following values:  eBay  PayPal AddressStatus ebl:AddressStatusTypeCode Status of street address on file with PayPal. It is one of the following values:  none  Confirmed  Unconfirmed Name xs:string Person’s name associated with this address.
PAGE 172
9 GetTransactionDetails API Operation GetTransactionDetails Response Message PaymentInfoType Fields Field Description TransactionID xs:string Unique transaction ID of the payment. Character length and limitations: 17 single-byte characters ParentTransactionID xs:string Parent or related transaction identification number. This value in this field is for the following transaction types:  Reversal – Capture of an authorized transaction.  Reversal – Reauthorization of a transaction.
PAGE 173
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description 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 (,).
PAGE 174
9 174 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PaymentStatus ebl:PaymentStatusCodeType Status of the payment. It is one of the following values:  None – No status  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.
PAGE 175
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PendingReason 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.
PAGE 176
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description ProtectionEligibili ty xs:string Prior to version 64.4, the kind of seller protection in force for the transaction. It is one of the following values:  Eligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.  PartiallyEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
PAGE 177
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PaymentItem ebl:PaymentItemType Amount of tax charged on payment. Subscription ebl:SubscriptionInfoType Subscription information. Auction ebl:AuctionInfoType Subscription information. 9 PaymentItemType Fields Field Description EbayItemTxnId xs:string (Optional) The eBay auction transaction ID of the item that you use to identify items that the buyer purchased.
PAGE 178
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description LoyaltyCardDiscount Currency xs:string (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.
PAGE 179
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description UserName xs:string Username that PayPal generates and gives to the subscriber to access the subscription. Character length and limitations: 64 alphanumeric single-byte characters Password xs:string Password that PayPal generates and gives to the subscriber to access the subscription. For security, the value of the password is hashed.
PAGE 180
9 180 GetTransactionDetails API Operation GetTransactionDetails Response Message February 01, 2013 SOAP API Developer Reference
PAGE 181
10 ManagePendingTransactionStatu s API Operation The ManagePendingTransactionStatus API operation accepts or denys a pending transaction held by Fraud Management Filters. ManagePendingTransactionStatus Request Message NOT E : 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.
PAGE 182
10 ManagePendingTransactionStatus API Operation ManagePendingTransactionStatus Response Message ManagePendingTransactionStatus Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. ManagePendingTransactionStatus Response Fields 182 Field Description TransactionID The transaction ID of the transaction whose payment has been denied or accepted.
PAGE 183
11 MassPay API Operation The MassPay API operation makes a payment to one or more PayPal account holders. MassPay Request Message NOT E : 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.
PAGE 184
11 MassPay API Operation MassPay Response Message Field Description MassPayItem ebl:MassPayItemType (Required) Details of each payment. NOTE: ReceiverType A single MassPayRequest can include up to 250 MassPayItems. ebl:ReceiverInfoCodeType (Optional) How you identify the recipients of payments in this call to MassPay. It is one of the following values:  EmailAddress  UserID  PhoneNumber MassPay Response Message NOT E : Not all fields shown are available for use.
PAGE 185
12 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.
PAGE 186
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : 186 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 187
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : 12 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 188
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : 188 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 189
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 190
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 191
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description CreditCard 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.
PAGE 192
12 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.
PAGE 193
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 BillingPeriodDetailsType Fields Field Description PaymentPeriod.Billi ngPeriod ns:BillingPeriodType (Required) Unit for billing during this subscription period. It is one of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth, billing is done on the 1st and 15th of each month. NOTE: PaymentPeriod.
PAGE 194
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TrialPeriod.Billing Period ns:BillingPeriodType Unit for billing during this subscription period; required if you specify an optional trial period. It is one of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth, billing is done on the 1st and 15th of each month. NOTE: TrialPeriod.
PAGE 195
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TaxAmount cc:BasicAmountType (Optional) Taxamount for each billing cycle during this payment period. NOTE: 12 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 (.
PAGE 196
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation AddressType (Shipping) Fields 196 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.
PAGE 197
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 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:  Visa  MasterCard  Discover  Amex  Maestro: See note.
PAGE 198
12 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 PayerInfoType 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.
PAGE 199
Recurring Payments and Reference Transactions API Operations 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.
PAGE 200
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation PaymentDetailsItemType Fields Field Description ItemCategory 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:  Digital  Physical This field is introduced in version 69.0. Name xs:string Item name. This field is required when ItemCategory is passed.
PAGE 201
Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description Tax ebl:BasicAmountType (Optional) Item sales tax. NOT E : 12 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.
PAGE 202
12 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 NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 203
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 GetRecurringPaymentsProfileDetails Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 204
12 204 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 205
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 206
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation NOT E : 206 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 207
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation NOT E : 12 Not all fields shown are available for use. Use only the fields described in the documentation. GetRecurringPaymentsProfileDetails Response Fields Field Description ProfileID xs:string Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. ProfileStatus ns:RecurringPaymentsProfileStatusType Status of the recurring payment profile.
PAGE 208
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description AutoBillOutstanding Amount ns:AutoBillType 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.
PAGE 209
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 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.
PAGE 210
12 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.
PAGE 211
Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description Amount cc:BasicAmountType Billing amount for each billing cycle during this payment period. This amount does not include shipping and tax amounts. NOTE: 12 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.
PAGE 212
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description OutstandingBalance cc:BasicAmountType 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.
PAGE 213
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 Maestro card was issued.
PAGE 214
12 Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation Field Description AddressStatus ebl:AddressStatusTypeCode Status of street address on file with PayPal. It is one of the following values:  none  Confirmed  Unconfirmed Name xs:string Person’s name associated with this address. Character length and limitations: 32 single-byte characters Street1 xs:string First street address.
PAGE 215
Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation 12 ManageRecurringPaymentsProfileStatus Request Message NOT E : 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.
PAGE 216
12 Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation ManageRecurringPaymentsProfileStatus Response Message NOT E : 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 CreateRecurringPaymentsProfile response.
PAGE 217
Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation 12 BillOutstandingAmount Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 218
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description 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.
PAGE 219
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 UpdateRecurringPaymentsProfile Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 220
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation NOT E : 220 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 221
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation NOT E : 12 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 222
12 222 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 223
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 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.
PAGE 224
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description Amount cc:BasicAmountType (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).
PAGE 225
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description MaxFailedPayments xs:int (Optional) The number of failed payments allowed before the profile is automatically suspended. The specified value cannot be less than the current number of failed payments for this profile. Character length and limitations: Number string representing an integer BillingStartdate xs:dateTime (Optional) The date when billing for this profile begins.
PAGE 226
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description 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.
PAGE 227
Recurring Payments and Reference Transactions API Operations 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: 12 All amounts in the CreateRecurringPaymentsProfile request must have the same currency.
PAGE 228
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 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:  Visa  MasterCard  Discover  Amex  Maestro: See note.
PAGE 229
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description IssueNumber xs:string (Optional) Issue number of Maestro card. Character length and limitations: 2 numeric digits maximum 12 PayerInfoType Fields Field Description Payer ns:EmailAddressType (Optional) Email address of buyer.
PAGE 230
12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description 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.
PAGE 231
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation NOT E : 12 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 NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 232
12 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.
PAGE 233
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description LocaleCode xs:string (Optional) Locale of pages displayed by PayPal during checkout.
PAGE 234
12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description cpp-header-image 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.
PAGE 235
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description BillingAgreement Description xs:string 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”.
PAGE 236
12 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. N O TE : The token expires after 3 hours.
PAGE 237
Recurring Payments and Reference Transactions API Operations CreateBillingAgreement API Operation 12 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 CreateBillingAgreement API Response Message NOT E : Not all fields shown are available for use.
PAGE 238
12 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 NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 239
Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 12 GetBillingAgreementCustomerDetails Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Only use fields described in the documentation.
PAGE 240
12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation NOT E : Not all fields shown are available for use. Only use fields described in the documentation. GetBillingAgreementCustomerDetails Response Fields 240 Field Description PayerInfo ns:PayerInfoType Information about the buyer such as the buyer’s name, email address, and country of residence.
PAGE 241
Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 12 PayerInfoType 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.
PAGE 242
12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation Field Description LastName ebl:NameType Buyer's last name. Character length and limitations: 25 single-byte characters Suffix ebl:SuffixType Buyer's suffix. Character length and limitations: 12 single-byte characters AddressType Fields 242 Field Description AddressStatus ebl:AddressStatusTypeCode Status of street address on file with PayPal.
PAGE 243
Recurring Payments and Reference Transactions API Operations BAUpdate API Operation 12 BAUpdate API Operation The BAUpdate API operation updates or deletes a billing agreement. BAUpdate Request Message NOT E : 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.
PAGE 244
12 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description BillingAgreement Description xs:string (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”.
PAGE 245
Recurring Payments and Reference Transactions API Operations BAUpdate API Operation NOT E : 12 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 246
12 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. BAUpdate Response Fields 246 Field Description BillingType ns:BillingCodeType Type of billing agreement. BillingAgreement Description xs:string Description of goods or services associated with the billing agreement. This field is required for each recurring payment billing agreement.
PAGE 247
Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description BillingAgreement Custom xs:string Custom annotation field for your own use. Character length and limitations: 256 single-byte alphanumeric characters BillingAgreementSta tus ebl:MerchantPullStatusCodeType (Optional) Use to cancel a billing agreement. To cancel a billing agreement, pass the value Canceled.
PAGE 248
12 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.
PAGE 249
Recurring Payments and Reference Transactions API Operations 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.
PAGE 250
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : 250 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 251
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation SOAP API Developer Reference February 01, 2013 12 251
PAGE 252
12 252 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 253
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : 12 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 purchase, 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.
PAGE 254
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PaymentType ns:MerchantPullPaymentCodeType (Optional) Specifies type of PayPal payment you require for the billing agreement. It is one of the following values.  Any  InstantOnly NOTE: Echeck is not supported for DoReferenceTransaction requests. PaymentDetails ebl:PaymentDetailsType (Required) Information about the payment.
PAGE 255
Recurring Payments and Reference Transactions API Operations 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.
PAGE 256
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation AddressType (Shipping) Fields 256 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.
PAGE 257
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 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.
PAGE 258
12 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 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.
PAGE 259
Recurring Payments and Reference Transactions API Operations 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:  Any value other than Y – This is not a recurring transaction (default).
PAGE 260
12 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 positive integer Tax ebl:BasicAmountType (Optional) Item sales tax.
PAGE 261
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 ReferenceCreditCardDetailsType Fields Field Description CreditCardType ebl:CreditCardType (Optional) Type of credit card. Is one of the following values:  Visa  MasterCard  Discover  Amex  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.
PAGE 262
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 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 262 Field Description Salutation xs:string (Optional)Buyer's salutation.
PAGE 263
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 DoReferenceTransaction Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 264
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : 264 Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 265
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 266
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description AVSCode xs:string Address Verification System response code. Character limit: 1 single-byte alphanumeric character CVV2Code xs:string Result of the CVV2 check by PayPal. BillingAgreementID xs:string Billing agreement identifier returned if the value of ReferenceID in the request is a billing agreement identification number. FMFDetails ebl:FMFDetailsType Fraud filter details.
PAGE 267
Recurring Payments and Reference Transactions API Operations 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:  Reversal – Capture of an authorized transaction.  Reversal – Reauthorization of a transaction.  Capture of an order – The value of ParentTransactionID is the original OrderID.
PAGE 268
12 268 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. 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 (,).
PAGE 269
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PaymentStatus ebl:PaymentStatusCodeType Status of the payment. It is one of the following values:  None – No status  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.
PAGE 270
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PendingReason 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.
PAGE 271
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description ProtectionEligibili ty xs:string Prior to version 64.4, the kind of seller protection in force for the transaction. It is one of the following values:  Eligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.  PartiallyEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
PAGE 272
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation RiskFilterListType Fields 272 Field Description ID xs:int Filter ID.
PAGE 273
13 RefundTransaction API Operation The RefundTransaction API operation issues a refund to the PayPal account holder associated with a transaction.
PAGE 274
13 RefundTransaction API Operation RefundTransaction Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. RefundTransaction Request Fields Field Description TransactionID xs:string (Required) Unique identifier of the transaction to be refunded. NOTE: Either the transaction ID or the payer ID must be specified.
PAGE 275
RefundTransaction API Operation RefundTransaction Request Message Field Description PayerID ebl:UserIDType (Optional) Encrypted PayPal customer account identification number. NOTE: 13 Either the transaction ID or the payer ID must be specified. Character length and limitations: 127 single-byte alphanumeric characters InvoiceID xs:string (Optional) Your own invoice or tracking number.
PAGE 276
13 RefundTransaction API Operation RefundTransaction Request Message Field Description MerchantStoreDetail s ns:MerchantStoreDetailsType (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:  true – The buyer was already given store credit for a given transaction.
PAGE 277
RefundTransaction API Operation RefundTransaction Response Message 13 RefundTransaction Response Message NOT E : 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 FeeRefundAmount ebl:BasicAmountType Transaction fee refunded to original recipient of payment.
PAGE 278
13 278 RefundTransaction API Operation RefundTransaction Response Message Field Description 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.
PAGE 279
RefundTransaction API Operation RefundTransaction Response Message 13 RefundInfoType Fields Field Description RefundStatus ns:PaymentStatusCodeType Status of the refund. It is one of the following values:  instant  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:  none – The refund status is instant.  echeck – The refund status is delayed.
PAGE 280
13 280 RefundTransaction API Operation RefundTransaction Response Message February 01, 2013 SOAP API Developer Reference
PAGE 281
14 TransactionSearch API Operation The TransactionSearch API searches transaction history for transactions that meet the specified criteria. NOT E : The maximum number of transactions that can be returned from a TransactionSearch API call is 100. TransactionSearch Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
PAGE 282
14 TransactionSearch API Operation TransactionSearch Request Message TransactionSearch Request Fields Field Description StartDate 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. EndDate 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.
PAGE 283
TransactionSearch API Operation TransactionSearch Request Message Field Description AuctionItemNumber 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.
PAGE 284
14 TransactionSearch API Operation TransactionSearch Request Message Field Description Status ebl:PaymentTransactionStatusCodeType (Optional) Search by transaction status. It is one of the following values:  Pending – The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field.  Processing – The payment is being processed.
PAGE 285
TransactionSearch API Operation TransactionSearch Response Message 14 TransactionSearch Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. NOT E : 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.
PAGE 286
14 286 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:  Currency Conversion (credit)  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”).
PAGE 287
A 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 tion Failed Username/Password is incorrect This error can be caused by an incorrect API username, an incorrect API password, or an invalid API signature. Make sure that all three of these values are correct.
PAGE 288
A API Error Codes Validation Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication/Authoriza tion Failed Client certificate is disabled 10006 Version error Version is not supported 10008 Security error Security header is not valid 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10101 This API Temporarily Unavailable This API is temporarily unavailable. Please try later.
PAGE 289
API Error Codes Validation Errors Error Code Short Message Long Message 81112 Missing Parameter NoShipping : Required parameter missing 81113 Missing Parameter AddrOverride : Required parameter missing 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 : Req
PAGE 290
A 290 API Error Codes Validation Errors Error Code Short Message Long Message 81143 Missing Parameter RefundType : Required parameter missing 81144 Missing Parameter StartDate : Required parameter missing 81145 Missing Parameter EndDate : Required parameter missing 81146 Missing Parameter MPID : Required parameter missing 81147 Missing Parameter CreditCardType : Required parameter missing 81148 Missing Parameter User : Required parameter missing 81149 Missing Parameter Pwd : Requir
PAGE 291
API Error Codes DirectPayment API Errors Error Code Short Message Long Message 81229 Invalid Parameter CompleteType : Invalid parameter 81230 Invalid Parameter CurrencyCode : Invalid parameter 81232 Invalid Parameter TransactionEntity : Invalid parameter 81234 Invalid Parameter ExpDate : Invalid parameter 81235 Invalid Parameter FirstName : Invalid parameter 81236 Invalid Parameter LastName : Invalid parameter 81237 Invalid Parameter Street : Invalid parameter 81238 Invalid Paramet
PAGE 292
A API Error Codes DirectPayment API Errors Error Code 292 Short Message Long Message Corrective Action 10401 Transaction refused Order total is missing. because of an invalid argument. See additional error messages for details. 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.
PAGE 293
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10505 Gateway Decline This transaction cannot be processed. The transaction was refused because the AVS response returned the value of N, and the merchant account is not able to accept such transactions. 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Your PayPal account is restricted. Contact PayPal for more information.
PAGE 294
A 294 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10527 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is invalid. 10534 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is currently restricted by PayPal. Contact PayPal for more information.
PAGE 295
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10546 Gateway Decline This transaction cannot be processed. The transaction was declined by PayPal because of possible fraudulent activity on the IP address. Contact PayPal for more information. 10547 Internal Error This transaction cannot be processed. None. This is a PayPal internal error. 10548 Invalid Configuration This transaction cannot be processed.
PAGE 296
A 296 API Error Codes DirectPayment API Errors Error Code Short Message Long Message 10562 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration year. 10563 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration month. 10564 Gateway Decline This transaction cannot be processed. 10565 Merchant country unsupported The merchant country is not supported.
PAGE 297
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10706 Invalid Data There’s an error with this transaction. Please enter a valid 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. 10707 Invalid Data There’s an error with this transaction. Please enter a valid country in the billing address.
PAGE 298
A 298 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10716 Invalid Data 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. 10717 Invalid Data There’s an error with this transaction. Please enter a valid postal code in the billing address.
PAGE 299
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10727 Invalid Data There’s an error with this transaction. Please enter an address1 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. 10727 Invalid Data There’s an error with this transaction. Please enter an address1 in the shipping address. There was a problem with a particular field in the address.
PAGE 300
A 300 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10736 Invalid Data 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. 10744 Invalid Data This transaction cannot be processed. Please enter a valid country code in the billing address.
PAGE 301
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10756 Gateway Decline The transaction cannot be processed. The country and billing address associated with this credit card do not match. None. This is a PayPal internal error. 10758 Invalid Configuration There’s been an error due to invalid API username and/or password. The API username or password is incorrect for this merchant. 10759 Gateway Decline This transaction cannot be processed.
PAGE 302
A API Error Codes DirectPayment API Errors Error Code 302 Short Message Long Message 11612 Could not process your request to accept/deny the transaction Could not process your request to accept/deny the transaction 11821 This transaction cannot be processed This transaction cannot be processed because it has already been denied by a Fraud Management Filter You cannot capture a payment after it has been denied by a Fraud Management Filter.
PAGE 303
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 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. A Corrective Action SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message 10001 ButtonSource value truncated.
PAGE 304
A API Error Codes SetExpressCheckout API Errors Error Code 304 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid item URL. 10004 Transaction refused because of an invalid argument. See additional error messages for details. OtherPaymentMethodType is invalid. 10004 Transaction refused because of an invalid argument. See additional error messages for details. RegistrationDate of buyer is invalid.
PAGE 305
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 306
A API Error Codes SetExpressCheckout API Errors Error Code 306 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. AllowPushFunding value specified is invalid. It must be 0 or 1 or an empty string. 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.
PAGE 307
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10405 Transaction refused because of an invalid argument. See additional error messages for details. CancelURL is missing. 10407 Transaction refused because of an invalid argument. See additional error messages for details. Invalid buyer email address (BuyerEmail). 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours.
PAGE 308
A 308 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error... 10412 Duplicate invoice Payment has already been made for this InvoiceID. PayPal checks that InvoiceID values are unique for any particular merchant. If you send an InvoiceID 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.
PAGE 309
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10427 Transaction refused because of an invalid argument. See additional error messages for details Shipping total is invalid. 10428 Transaction refused because of an invalid argument. See additional error messages for details Handling total is invalid. 10429 Transaction refused because of an invalid argument. See additional error messages for details Tax total is invalid.
PAGE 310
A API Error Codes SetExpressCheckout API Errors Error Code 310 Short Message Long Message 10438 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length. 10439 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length. 10440 Transaction refused because of an invalid argument.
PAGE 311
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10465 Error occurred in communicating to eBay eBay user invalid 10467 Error occurred in communicating to eBay Duplicate Item ID 10468 Transaction refused because of an invalid argument.
PAGE 312
A 312 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10480 Invalid Data Invalid billing agreement type 10485 Payment not authorized Payment has not been authorized by the user. 10537 Risk Control Country Filter Failure The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings.
PAGE 313
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 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.
PAGE 314
A API Error Codes SetExpressCheckout API Errors Error Code 314 Short Message Long Message 11810 Transaction refused because of an invalid argument. See additional error messages for details Invalid Insurance Amount. 11811 Transaction refused because of an invalid argument. See additional error messages for details Invalid Shipping Discount. 11812 Invalid Data The value of Description parameter has been truncated. 11813 Transaction refused because of an invalid argument.
PAGE 315
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 11827 Line items missing Line items missing; line items are required when you specify a callback URL for flat-rate shipping options 11828 Maximum amount of order not specified Maximum amount of order not specified; you must specify the estimated value of the order when using a flat-rate shipping option 11829 Shipping total is missing Shipping total is missing; you must specify a shipping total when using a flat-r
PAGE 316
A API Error Codes SetExpressCheckout API Errors Error Code 316 Short Message Long Message 12207 Cart ID is required for Immediate Payment item. Cart ID is required for Immediate Payment item. 12208 eBay item amount does not match Express Checkout API item amount. eBay item amount must match Express Checkout API item amount.
PAGE 317
API Error Codes GetExpressCheckoutDetails API Errors A GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10001 ButtonSource value truncated. The transaction could not be loaded 10001 ButtonSource value truncated. The transaction could not be loaded 10003 Missing argument. OtherPaymentMethodID is missing. 10003 Missing argument.
PAGE 318
A API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10007 Permission denied You do not have permission to make this API call 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10408 Express Checkout token is missing. Express Checkout token is missing. 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours.
PAGE 319
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 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. 10004 Transaction refused because of an invalid argument. See additional error messages for details. The transaction id is not valid 10004 Transaction refused because of an invalid argument.
PAGE 320
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 320 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay item transaction date. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay item buyer protection type. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 321
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error... 10412 Duplicate invoice Payment has already been made for this InvoiceID. You may have made a second DoExpressCheckoutPayment API call for the same payment. Or you may have used the same invoice ID for separate transactions, in which case inform the customer and redirect them to restart the Express Checkout flow. 10413 Transaction refused because of an invalid argument.
PAGE 322
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 322 Short Message Long Message Correcting This Error... 10421 This Express Checkout session belongs to a different customer. This Express Checkout session belongs to a different customer. Token value mismatch. Verify that your programs are properly associating the Tokens and PayerIDs. 10422 Customer must choose new funding sources. The customer must return to PayPal to select new funding sources.
PAGE 323
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10434 Transaction refused because of an invalid argument. See additional error messages for details. Value of Custom element has been truncated. 10435 Transaction refused because of an invalid argument. See additional error messages for details. The customer has not yet confirmed payment for this Express Checkout session. 10441 Transaction refused because of an invalid argument.
PAGE 324
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 324 Short Message Long Message 10482 Transaction refused because of an invalid argument. See additional error messages for details. PaymentAction of Order is not allowed with Unilateral and Non-Credentialed authentication. 10486 This transaction couldn't be completed. This transaction couldn't be completed. Please redirect your customer to PayPal.
PAGE 325
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error... 11084 User does not have a good funding source with which to pay. User does not have a good funding source with which to pay. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.com/contactus 11607 Duplicate request for specified Message Submission ID.
PAGE 326
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 326 Short Message Long Message 12125 PP incentive no longer available. There's a problem with the 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 processed at this time. Incentive temporarily unavailable.
PAGE 327
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is missing Payment Request ID is mandatory for parallel payments 13103 Duplicate Payment Request ID passed Payment Request ID must be unique for parallel payments 13104 Transaction refused because of an invalid argument. See Additional error messages for details.
PAGE 328
A API Error Codes Authorization and Capture API Errors Error Code 13751 Short Message Long Message Correcting This Error... Could not retrieve the original successful response. Transaction completed successfully, but could not retrieve the original successful response. Authorization and Capture API Errors Authorization and Capture API Error Messages 328 Error Code Short Message Long Message Returned By API Call...
PAGE 329
API Error Codes Authorization and Capture API Errors Error Code Short Message Long Message Returned By API Call... Correcting This Error... 10601 Authorization expired. Authorization has expired. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10602 Authorization completed. Authorization has already been completed. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10603 The buyer is restricted.
PAGE 330
A 330 API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10611 Not enabled. Authorization & Capture feature is not enabled for the merchant. Contact customer service. DoAuthorization DoCapture DoReauthorization Contact PayPal Customer Service. 10612 No more settlement. Maxmimum number of allowable settlements has been reached. No more settlement for the authorization. DoCapture Close the order.
PAGE 331
API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10621 Order has expired. Order has expired. DoAuthorization DoCapture DoVoid Close this order. 10622 Order is voided. Order is voided. DoAuthorization DoCapture DoVoid Close this order. 10623 Maximum number of authorization allowed for the order is reached. Maximum number of authorization allowed for the order is reached.
PAGE 332
A API Error Codes GetTransactionDetails API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10630 Item amount is invalid. Item amount is invalid. DoAuthorization DoCapture Check the item amount to ensure that it is not zero or negative. 10631 Processor Warning. The authorization is being processed. DoAuthorization 11094 This authorization cannot be voided, reauthorized, or captured against.
PAGE 333
API Error Codes TransactionSearch API Errors A TransactionSearch API Errors TransactionSearch API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 ButtonSource value truncated. The transaction could not be loaded 10003 Transaction refused because of an invalid argument. See additional error messages for details. Start date is a required parameter 10004 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 334
A API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Receiver email is invalid 10004 Transaction refused because of an invalid argument. See additional error messages for details. You can not search for a transaction id and a receipt id 10004 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 335
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10003 Missing argument A transaction id is required 10004 Transaction refused because of an invalid argument. See additional error messages for details. The partial refund amount must be a positive amount 10004 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 336
A 336 API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 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 The PayerID is invalid. The PayerID is invalid. Make the API call again with a valid PayerID.
PAGE 337
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10406 Transaction refused because of an invalid argument. See additional error messages for details. The PayerID value is invalid. 10414 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the maximum amount for a single transaction.
PAGE 338
A API Error Codes MassPay API Errors Error Code Short Message Long Message 11996 Use Adaptive Payment Refund API To do a refund on an Adaptive Payment transaction, please use the Adaptive Payment Refund API 12302 Dispute Refund Not Allowed This transaction already has a PayPal dispute filed 13122 Transaction refused Transaction violates PayPal Use Agreement 13513 Duplicate request for specified Invoice ID. The specified Invoice ID is a duplicate.
PAGE 339
API Error Codes MassPay API Errors Error Code Short Message Long Message 10001 Transaction refused because of an invalid argument. See additional error messages for details. The masspay receiver_type is not a recognizable type 10002 Account locked The user account is locked 10004 Transaction refused because of an invalid argument. See additional error messages for details. The number of input records is greater than maximum allowed 10004 Transaction refused because of an invalid argument.
PAGE 340
A API Error Codes MassPay API Errors Error Code 340 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The unique id string length exceeds the maximum limit of 30 characters 10004 Transaction refused because of an invalid argument. See additional error messages for details. The unique id string contains a space as a character 10004 Transaction refused because of an invalid argument.
PAGE 341
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10327 Masspay Invalid UserID The masspay input file includes invalid UserID A Recurring Payments Errors The following table lists errors for the following APIs that handle recurring payments profiles:  CreateRecurringPaymentsProfile  GetRecurringPaymentsProfileDetails  ManageRecurringPaymentsProfileStatus  UpdateRecurringPaymentsProfile  BillOutstandingAmount Recurring Payments Errors Error Code Short Mes
PAGE 342
A 342 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10478 Invalid Data Recurring payments profile description must be provided if the billing agreement type is recurring payments. 10501 Invalid Configuration This transaction cannot be processed due to an invalid merchant configuration. Occurs when the billing agreement is disabled or inactive.
PAGE 343
API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10513 Invalid Data This transaction cannot be processed. Please enter a last name. The last name of the buyer is required for this merchant. 10535 Gateway decline This transaction cannot be processed. Please enter a valid credit card number and type. 10544 Gateway Decline This transaction cannot be processed. 10544 Transaction cannot be processed. Please use a different payment card.
PAGE 344
A 344 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10713 Invalid Data There’s an error with this transaction. Please enter a country 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. 10744 Invalid Data This transaction cannot be processed. Please enter a valid country code in the billing address.
PAGE 345
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11506 Invalid max failed payments Max failed payments, if supplied, must be >= 0 11507 Invalid trial amount Trial amount must be >= 0 11508 Invalid trial total billing cycles Trial total billing cycles must be > 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 >= 0 11511 Invalid currency for trial amou
PAGE 346
A 346 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11531 Invalid profile status The profile status must be one of (A)ctive, (C)ancelled, or e(X)pired 11543 Invalid payer country The payer’s country is currently not supported 11544 Invalid period status The trial period status must be one of (A)ctive or (C)ancelled 11545 Denied Payer’s account is denied 11546 Denied Merchant account is denied 11547 This feature is not available at this time Recurring
PAGE 347
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 11564 The number of failed payments should be greater than the current number of failed payments The number of failed payments should be greater than the current number of failed payments 11567 The time of the update is too close to the billing date The time of the update is too close to the billing date 11568 Invalid currency for delinquent amount Invalid currency for delinquent amount 11569 Cannot increase delinq
PAGE 348
A API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 11590 Profile update is not required Based on your input request, profile already up to date. 11592 Subscription profiles are not supported for recurring payments Subscription profiles are not supported for recurring payments 11607 Duplicate request for specified Message Submission ID.
PAGE 349
API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid value for request billing address parameter. 10405 Transaction refused because of an invalid argument. See additional error messages for details. CancelURL is missing. CancelURL tag has no content. 10407 Transaction refused because of an invalid argument. See additional error messages for details.
PAGE 350
A API Error Codes GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 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.
PAGE 351
API Error Codes CreateBillingAgreement Errors A CreateBillingAgreement Errors CreateBillingAgreement Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10408 Missing token Token is missing Token is missing. 10409 You’re not authorized to access this info. Express Checkout token was issued for a merchant account other than yours. Token belongs to a different merchant.
PAGE 352
A API Error Codes UpdateBillingAgreement Errors Error Code 352 Short Message Long Message Additional Information 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid argument; description field or custom field is empty and the status is active Check the description and custom fields of the billing agreement.
PAGE 353
API Error Codes DoReferenceTransaction Errors A DoReferenceTransaction Errors All Reference Transactions-Related API Errors Error Code Short Message Long Message Additional Information 10001 Internal Error Internal Error Retry the transaction 5 more times at incremental intervals. If this continues to fail instruct the customer of the error & contact Merchant Technical Support https://www.paypal.com/mts for assistance.
PAGE 354
A 354 API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10014 API call was rate limited. The API call has been denied as it has exceeded the permissible call rate limit. 10069 Payment refused due to risk; user notification necessary. Payment could not be completed due to a sender account issue. Please notify the user to contact PayPal Customer Support.
PAGE 355
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10209 Disabled Preapproved Payments not enabled. Merchants is not enabled for preapproved payments (PAP); applies only to legacy PAP billing agreements. 10210 No Funding Transaction failed because has no funding sources Payee has no funding sources. Invalid MP ID Invalid MP ID. A profile preference is set that automatically denies this kind of transaction.
PAGE 356
A API Error Codes DoReferenceTransaction Errors Error Code 356 Short Message Long Message Additional Information 10414 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the maximum amount for a single transaction. Amount exceeds the max amount for a single txn. 10417 Transaction cannot complete. The transaction cannot complete successfully. Instruct the customer to use an alternative payment method.
PAGE 357
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10429 Transaction refused because of an invalid argument. See additional error messages for details. Tax total is invalid. TaxTotal amount is invalid. 10429 Transaction refused because of an invalid argument. See additional error messages for details. Item sales tax is invalid PaymentDetailsItem.Tax field is invalid. Warning only; API executes.
PAGE 358
A 358 API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.com/contact us 10527 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type.
PAGE 359
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10622 Order is voided. Order is voided. 10623 Maximum number of authorization allowed for the order is reached. Maximum number of authorization allowed for the order is reached. 10725 Shipping Address Country Error There was an error in the Shipping Address Country field Shipping address error in country field.
PAGE 360
A API Error Codes DoReferenceTransaction Errors Error Code 360 Short Message Long Message Additional Information 11091 The transaction was blocked as it would exceed the sending limit for this buyer. The transaction was blocked as it would exceed the sending limit for this buyer. Inform the customer that PayPal declined the transaction and to contact PayPal Customer Service for more information: https://www.paypal.
PAGE 361
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 11452 Merchant not enabled for reference transactions Merchant not enabled for reference transactions This merchant is not enabled for Mark reference transaction. 11453 Reference transactions temporarily unavailable. Reference transaction feature not currently available; try again later Feature wired off. 11453 Reference transactions temporarily unavailable.
PAGE 362
A API Error Codes AddressVerify API Errors Error Code Short Message Long Message Additional Information 13701 Invalid Data Item Category value is invalid. Only Digital or Physical are allowed. Scenario: When merchant passes an item category value other than Digital or Physical. 18014 Gateway Decline This transaction cannot be processed. This transaction cannot be processed without a Credit Card Verification number.
PAGE 363
API Error Codes ManagePendingTransactionStatus API Errors Error Code Short Message Long Message 11614 The transaction has already been Accepted/Denied and the status cannot be changed The transaction has already been Accepted/Denied and the status cannot be changed SOAP API Developer Reference February 01, 2013 A 363
PAGE 364
A 364 API Error Codes ManagePendingTransactionStatus API Errors February 01, 2013 SOAP API Developer Reference
PAGE 365
B Countries and Regions Supported by PayPal PayPal uses 2-character IS0-3166-1 codes for specifying 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. NOT E : It is important that you pass the correct country code when sending a charge transaction to PayPal in API calls such as: DoExpressCheckoutPayment, DoReferenceTransaction and SetExpressCheckout.
PAGE 366
B 366 Countries and Regions Supported by PayPal Country or Region Country or Region Code BHUTAN BT BOSNIA-HERZEGOVINA BA BOTSWANA BW BOUVET ISLAND * BV * BRAZIL BR BRITISH INDIAN OCEAN TERRITORY * IO * BRUNEI DARUSSALAM BN BULGARIA BG BURKINA FASO BF CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC * CF * CHILE CL CHINA CN (For domestic Chinese bank transactions only) C2 (For CUP, bank card and cross-border transactions) CHRISTMAS ISLAND * CX * COCOS (K
PAGE 367
Countries and Regions Supported by PayPal Country or Region Country or Region Code ESTONIA EE FALKLAND ISLANDS (MALVINAS) FK FAROE ISLANDS FO FIJI FJ FINLAND FI FRANCE FR FRENCH GUIANA 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 HONDURA
PAGE 368
B 368 Countries and Regions Supported by PayPal Country or Region Country or Region Code ISLE OF MAN IM ISRAEL IL ITALY IT JAMAICA JM 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 MW MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX
PAGE 369
Countries and Regions Supported by PayPal Country or Region Country or Region Code MONACO MC MONGOLIA MN MONTENEGRO ME MONTSERRAT MS 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 PH PITCAIRN PN POLAND PL PORTUGAL
PAGE 370
B 370 Countries and Regions Supported by PayPal Country or Region Country or Region Code REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW SAINT HELENA SH SAINT KITTS AND NEVIS KN SAINT LUCIA LC SAINT PIERRE AND MIQUELON PM SAINT VINCENT AND THE GRENADINES VC SAMOA WS SAN MARINO SM SAO TOME AND PRINCIPE * ST * SAUDI ARABIA SA SENEGAL SN SERBIA RS SEYCHELLES SC SINGAPORE SG SLOVAKIA SK SLOVENIA SI SOLOMON ISLANDS SB SOUTH AFRICA ZA SOUTH GEORGIA AND THE SOUT
PAGE 371
Countries and Regions Supported by PayPal Country or Region Country or Region Code TIMOR-LESTE TL TOGO TG TOKELAU TK TONGA TO 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.
PAGE 372
B 372 Countries and Regions Supported by PayPal February 01, 2013 SOAP API Developer Reference
PAGE 373
C State and Province Codes Canadian Province or U.S.
PAGE 374
C 374 State and Province Codes Canadian Province or U.S.
PAGE 375
State and Province Codes Canadian Province or U.S.
PAGE 376
C 376 State and Province Codes February 01, 2013 SOAP API Developer Reference
PAGE 377
D 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 N O TE : This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only.
PAGE 378
D Currency Codes Currency Currency Code Swiss Franc CHF Taiwan New Dollar TWD N O TE : This currency does not support decimals. Decimal amounts will throw an error. Thai Baht THB Turkish Lira TRY N O TE : This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only. U.S.
PAGE 379
Currency Codes 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 SEK Visa, MasterCard Visa, MasterCard Swiss Franc CHF Visa, MasterCard Visa, MasterCard U.S.
PAGE 380
D 380 Currency Codes February 01, 2013 SOAP API Developer Reference
PAGE 381
E AVS and CVV2 Response Codes AVS Response Codes 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 NOT E : The transaction is declined.
PAGE 382
E AVS and CVV2 Response Codes AVS Response Codes AVS Code Meaning Matched Details W Whole ZIP Nine-digit ZIP code (no Address) 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.
PAGE 383
AVS and CVV2 Response Codes CVV2 Response Codes E CVV2 Response Codes CVV2 Response Codes for Visa, MasterCard, Discover, and American Express CVV2 Code Meaning Matched Details E Error - Unrecognized or Unknown response Not applicable 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 X No response Not applicable CVV2 Response Codes for Maestro CVV2 Code M
PAGE 384
E 384 AVS and CVV2 Response Codes CVV2 Response Codes February 01, 2013 SOAP API Developer Reference
PAGE 385
About Previous Versions of the API Previous versions of the API can still be used; however, PayPal recommends using the latest version whenever possible. Unless specifically specified, API operations default to the latest version. What’s New in Version 95.0 Maintenance release. Updated for 95.0. Added new 11800 error field and fulfillmentReferenceNumber field related to Global Shipping Program (GSP). See PayPal Release Notes for more information: https://www.x.
PAGE 386
About Previous Versions of the API What’s New in Version 88.0 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 New Field in RefundTransaction Response Field Description RefundInfo ebl:RefundInfoType Contains refund payment status information. This field is available since version 84.0.
PAGE 387
About Previous Versions of the API What’s New in Version 82.0 New Field in DoReferenceTransactionResponseDetailsType 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/?&cmd=_rendercontent&content_ID=merchant/cc_compliance_error_codes This field is available since version 84.0.
PAGE 388
About Previous Versions of the API What’s New in 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 This field is available since version 82.0.
PAGE 389
About Previous Versions of the API What’s New in Version 80.0 Field Description RefundType ebl:RefundPurposeTypeCodeType Type of refund you are making. It is one of the following values:  Full – Full refund (default).  Partial – Partial refund.  ExternalDispute – External dispute. (Value available since version 82.0)  Other – Other type of refund. (Value available since version 82.
PAGE 390
About Previous Versions of the API What’s New in Version 74.0 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:  Any value other than Y – This is not a recurring transaction (default).  Y – This is a recurring transaction.
PAGE 391
About Previous Versions of the API What’s New in Version 72.0 What’s New in Version 72.0 Changes to BuyerDetailsType in SetExpressCheckout Request BuyerDetailsType Fields Field Description TaxIdDetails ebl:TaxIdDetailsType Details about the buyer’s tax information. This field is required for Brazil and is for Brazil use only. New TaxIdDetailsType Structure in SetExpressCheckout Request TaxIdDetailsType Fields Field Description TaxIdType New field xs:string The buyer’s tax ID type.
PAGE 392
About Previous Versions of the API What’s New in Version 69 Field Description TaxId 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.
PAGE 393
About Previous Versions of the API What’s New in Version 69 Field Description Amount New field ebl:BasicAmountType Cost of item. This field is required when you pass a value for ItemCategory. NOT E : 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 (.
PAGE 394
About Previous Versions of the API What’s New in Version 66 Field Description Amount ebl:BasicAmountType Cost of item. This field is required when you pass a value for ItemCategory. N O TE : 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 (.
PAGE 395
About Previous Versions of the API What’s New in Version 66 Changes to PaymentDetailsItemTypein SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsItemType Fields Field Description ItemCategory 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:  Digital  Physical Name xs:string Item name.
PAGE 396
About Previous Versions of the API What’s New in Version 66 Changes to PaymentDetailsItemType 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:  Digital  Physical This field is available since version 65.1.
PAGE 397
Revision History Date Description 01 February 2013 Maintenance release. Updated for 98.0. See PayPal Merchant API Release Notes for more information: https://www.x.com/developers/paypal/documentation-tools/releasenotes#MerchantAPI 14 December 2012 Maintenance release. See PayPal Merchant API Release Notes for more information: https://www.x.com/developers/paypal/documentationtools/release-notes 14 November 2012 Maintenance release.
PAGE 398
Revision History 398 Date Description 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 request. Added new field to DoDirectPayment API and DoReferenceTransaction API responses. Edits to improve accuracy. 1 September 2011 General edits to improve consistency. 5 April 2011 Updated for 71.0.
PAGE 399
Revision History Date Description April 2008 Added Fraud Management Filters information. Changed recurring payments information. February 2008 Added that ther VERSION parameter must be 50.0 in the API call to use recurring payments. January 2008     September 2007    Added billing agreement fields to SetExpressCheckout for recurring payments Updated CreateRecurringPaymentsProfile for new recurring payments features.
PAGE 400
Revision History 400 February 01, 2013 SOAP API Developer Reference
PAGE 401
Index A AcceptFilters response field 68, 151, 271 Action request field 181, 215 ActivationDetails request field 192 ActivationDetailsType request fields 195 AdditionalBilling Cycles request field 223 Address Owner response field 171, 213 Address request field 59, 77, 88, 198, 229 Address response field 117, 170, 213, 241, 248 AddressOverride request field 89 AddressStatus response field 118, 171, 209, 214, 242 AddressType (Shipping) request fields 65, 94, 131, 196, 225, 256 AddressType (Shipping) response
PAGE 402
Index BillOutstandingAmount request fields 217 BillOutstandingAmount request message 217 BillOutstandingAmount response fields 218 BillOutstandingAmount response message 218 BrandName request field 93 Brazilian Real 377 BRL 377 Business response field 169 ButtonSource request field 63, 131, 134, 258 BuyerDetails request field 93 BuyerDetailsType request fields 102 BuyerEmail request field 91, 234 BuyerEmailOptinEnable request field 94 BuyerId request field 102 BuyerID response field 178 BuyerMarketingEmail
PAGE 403
Index D Danish Krone 377, 378 dateÚtime formats 24 DenyFilters response field 68, 151, 271 Description request field 64, 99, 136, 192, 200, 223, 259, 392, 395 Description response field 69, 122, 152, 207, 272 Discover AVS response codes 381 Discover CVV2 response codes 383 DKK 377, 378 Do Reauthorization request fields 44 Do Reauthorization response fields 45 DoAuthorization API operation 39 DoAuthorization request fields 40 DoAuthorization request message 40 DoAuthorization response fields 41 DoAuthorizat
PAGE 404
Index FirstName response field 117, 170, 213, 241, 248 FlatR ateShippingOptions request field 88 FMFDetails response field 68, 144, 150, 266 FMFDetailsType response fields 68, 151, 271 Forint 377, 378 FulfillmentAddress 98 FulfillmentAddress field 121, 122 FundingSourceDetails request field 93 FundingSourceDetailsType request fields 102 G GBP 377, 378 Get ExpressCheckout Details request fields 106 GetBalance API operation 153 GetBalance request fields 153 GetBalance request message 153 GetBalance response
PAGE 405
Index LandingPage request field 92 LastName request field 60, 76, 77, 199, 229, 262, 284 LastName response field 117, 170, 213, 242, 248 LastPaymentAmount response field 212 LastPaymentDate response field 212 Locale response field 157 LocaleCode request field 90, 233 LongMessage response field 126, 151 LoyaltyCardDiscountAmount 177 LoyaltyCardDiscountCurrency 178 ManagePendingTransactionStatus API operation 181 ManagePendingTransactionStatus request fields 181 ManagePendingTransactionStatus request messag
PAGE 406
Index Name response field 69, 118, 122, 152, 171, 177, 209, 214, 242, 248, 272 NetAmount request field 74 NetAmount response field 286 NetRefundAmount response field 278 New Zealand Dollar 377, 378 NextBillingDate response field 211 NOK 377, 378 Norwegian Krone 377, 378 NoShipping request field 88 Note request field 32, 49, 215, 218, 223 Note response field 115, 143 NoteT ext request field 98 NoteText request field 135 NoteText response field 122 Noti fyURL request field 63 NotifyURL request field 98, 135,
PAGE 407
Index PaymentTransactionDetails response field 166 PaymentTransactionDetails response fields 168 PaymentType request field 104, 235, 254 PaymentType response field 146, 172, 267 PayPalAccountID request field 101 PayPalAccountID response field 125, 151 PayPalAdjustment response field 115 PayPalToken response field 29 PendingFilters response field 69, 151, 271 PendingReason request field 279 PendingReason response field 43, 47, 148, 175, 270 Period response field 179 Peso 377 Philippine Peso 377 Phone reques
PAGE 408
Index RiskFilterListType response fields 69, 152, 272 S SalesTax response field 176 Salutation request field 60, 76, 198, 262, 284 Salutation response field 170, 241, 248 ScheduleDetails request field 191 ScheduleDetailsType request fields 192 SecureMerchantAccountID response field 151 security 17 SEK 377, 379 SellerDetails request field 98, 135 SellerDetails response field 150 SellerDetailsType request fields 139 SellerID request field 139 SellerRegistrationDate request field 139 SellerUserName request f
PAGE 409
Index SurveyChoice request field 94 SurveyChoiceSelected request field 131 SurveyChoiceSelected response field 116, 168 SurveyEnable request field 94 SurveyQuestion request field 94, 131 SurveyQuestion response field 116 SurveyQuestionresponse field 168 Swedish Krona 377, 379 Swiss Franc 378, 379 T Taiwan New Dollar 378 Tax request field 64, 100, 137, 201, 260, 393 Tax response field 123 TaxAmount request field 74, 195, 224, 227 TaxAmount response field 146, 173, 211, 268 TaxId request field 104 TaxId res
PAGE 410
Index Y Yen 377, 378 Z Zip request field 28 ZipMatch response field 29 Zloty 377, 378 410 February 01, 2013 SOAP API Developer Reference