SOAP API Developer Reference Last updated: August 2012
SOAP API Developer Reference Document Number: 100002.en_US-201208 © 2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A.
Contents What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 What’s New in Version 93.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Where to Go for More Information . . . . . . . . . . .
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 DoAuthorization Request Message . . . . . . . . . . . . . . .
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 . . . . . . . . . . . . . . .
Contents PaymentItemInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178 PaymentItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179 AuctionInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180 SubscriptionInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180 SubscriptionTermsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents CreateBillingAgreement API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . .238 CreateBillingAgreement Request Message . . . . . . . . . . . . . . . . . . . . . . .238 CreateBillingAgreement API Response Message . . . . . . . . . . . . . . . . . . . .239 GetBillingAgreementCustomerDetails API Operation . . . . . . . . . . . . . . . . . . . .240 GetBillingAgreementCustomerDetails Request Message . . . . . . . . . . . . . . . .240 GetBillingAgreementCustomerDetails Response Message . .
Contents TransactionSearch API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .331 RefundTransaction API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333 MassPay API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .336 Recurring Payments Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .338 SetCustomerBillingAgreement Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents New Field in DoCapture Request . . . . . . . . . . . . . . . . . . . . . . . . . . . .377 New MerchantStoreDetailsType in DoCapture Request . . . . . . . . . . . . . . . . .377 New Fields in RefundTransaction Request . . . . . . . . . . . . . . . . . . . . . . .378 New MerchantStoreDetailsType in RefundTransaction Request . . . . . . . . . . . .378 What’s New in Version 80.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 10 August 2012 SOAP API Developer Reference
What’s New What’s New in Version 93.0 Maintenance release. New 10486 error code added for redirects when the process declines the transaction: The transaction couldn’t be completed. Please redirect your customer to PayPal.
What’s New in Version 93.
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.
Documentation Feedback 14 August 2012 SOAP API Developer Reference
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.
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.
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.
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.
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
1 PayPal SOAP API Basics Request Structure api_username api_password service_version data
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:
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.
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.
1 PayPal SOAP API Basics CorrelationID for Reporting Problems to PayPal debugging_info 1.000000 1.0006.. other elements in response.
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.
1 26 PayPal SOAP API Basics Core Currency Amount Data Type August 2012 SOAP API Developer Reference
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.
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.
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.
2 30 AddressVerify API Operation AddressVerify Response Message August 2012 SOAP API Developer Reference
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.
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.
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.
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.
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.
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.
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.
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.
Authorization and Capture API Operation Reference DoCapture 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.
3 Authorization and Capture API Operation Reference DoAuthorization API Operation DoAuthorization API Operation Authorize a payment. 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.
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.
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.
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.
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.
Authorization and Capture API Operation Reference DoReauthorization API Operation 3 DoReauthorization Request Fields Field Description AuthorizationID xs:string (Required) Value of a previously authorized transaction identification number returned by PayPal. Character length and limitations: 19 single-byte characters Amount ebl:BasicAmountType (Required) Amount to reauthorize. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
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.
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.
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.
Authorization and Capture API Operation Reference DoVoid API Operation 3 DoVoid Request Fields Field Description AuthorizationID xs:string (Required) Original authorization ID specifying the authorization to void or, to void an order, the order ID. I MP O R T ANT : If you are voiding a transaction that has been reauthorized, use the ID from the original authorization, and not the reauthorization.
3 Authorization and Capture API Operation Reference DoVoid API Operation DoVoidResponse Fields 50 Field Description AuthorizationID xs:string Authorization identification number you specified in the request.
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.
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.
DoDirectPayment API Operation DoDirectPayment Request Message SOAP API Developer Reference August 2012 4 53
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
DoDirectPayment API Operation DoDirectPayment Response Message Field Description ReportsFilters xs:RiskFilterListType List of filters that caused the payment to become flagged. 4 RiskFilterListType Fields Field Description ID xs:int Filter ID.
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.
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.
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.
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.
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 (,).
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.
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.
DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description LastName ns:PersonNameType (Required) Buyer’s last name. Character length and limitations: 25 single-byte characters Address ns:AddressType (Required) Buyer’s billing address information. 5 AddressType Fields Field Description Street1 xs:string (Required) First street address. Character length and limitations: 100 single-byte characters Street2 xs:string (Optional) Second street address.
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.
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.
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.
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.
6 82 ExpressCheckout API Operations SetExpressCheckout API Operation August 2012 SOAP API Developer Reference
ExpressCheckout API Operations SetExpressCheckout API Operation SOAP API Developer Reference August 2012 6 83
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.
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.
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.
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.
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.
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.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LocaleCode xs:string (Optional) Locale of pages displayed by PayPal during Express Checkout.
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.
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.
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.
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.
ExpressCheckout API Operations SetExpressCheckout API Operation 6 AddressType Fields Field Description Name xs:string Person’s name associated with this shipping address. It is required if using a shipping address. Character length and limitations: 32 single-byte characters Street1 xs:string First street address. It is required if using a shipping address. Character length and limitations: 100 single-byte characters Street2 xs:string (Optional) Second street address.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description OrderTotal ebl:BasicAmountType (Required) Total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases.
ExpressCheckout API Operations SetExpressCheckout API Operation Field Description ShippingDiscount ebl:BasicAmountType (Optional) Shipping discount for this order, specified as a negative number. 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.
6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description Custom xs:string (Optional) A free-form field for your own use. NOTE: The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 256 single-byte alphanumeric characters InvoiceID xs:string (Optional) Your own invoice or tracking number.
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.
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.
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.
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.
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.
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”.
ExpressCheckout API Operations SetExpressCheckout 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.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation G e t E x p r e s s C h e c k o u t D e ta i l s A P I O p e r a t i o n The GetExpressCheckoutDetails API operation obtains information about an Express Checkout transaction. GetExpressCheckoutDetails Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
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.
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.
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.
6 110 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation August 2012 SOAP API Developer Reference
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.
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.
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.
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.
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.
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.
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.
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.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description OrderTotal ebl:BasicAmountType The total cost of the transaction to the buyer. If shipping cost (not applicable to digital goods) and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases.
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.
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.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description EnhancedPaymentData ed:EnhancedPaymentDataType Enhanced Data section to accept channel-specific data. NoteText xs:string Note to the merchant. Character length and limitations: 255 single-byte characters TransactionId xs:string Transaction identification number of the transaction that was created. NOTE: This field is only returned after a successful transaction for DoExpressCheckout has occurred.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description Quantity xs:integer Item quantity. Character length and limitations: Any positive integer Tax ebl:BasicAmountType Item sales tax. 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.
6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation EbayItemPaymentDetailsItemType Fields Field Description ItemNumber xs:string Auction item number. Character length: 765 single-byte characters AuctionTransactionId xs:string Auction transaction identification number. Character length: 255 single-byte characters OrderID xs:string Auction order identification number.
ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description ShippingOptionName xs:string The name of the shipping option, such as air or ground. 6 SellerDetailsType Fields Field Description PayPalAccountID xs:string Unique identifier for the merchant. For parallel payments, this field contains either the Payer Id or the email address of the merchant.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation TaxIdDetailsType Fields Field Description TaxIdType xs:string Buyer’s tax ID type. This field is required for Brazil and used for Brazil only. For Brazil use only: The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses. This field is introduced in API version 72.0. TaxId xs:string Buyer’s tax ID. This field is required for Brazil and used for Brazil only.
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.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 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.
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.
6 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description Phone xs:string (Optional) Phone number. Character length and limitations: 20 single-byte characters 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 (Required) The total cost of the transaction to the buyer.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ShippingTotal ebl:BasicAmountType (Optional) Total shipping costs for 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description TaxTotal ebl:BasicAmountType (Optional) Sum of tax for all items in 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.
6 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 : The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
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.
6 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 : 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.
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. ItemURL xs:string (Optional) URL for the item.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 DoExpressCheckoutPayment Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation NOT E : 140 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
6 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. DoExpressCheckoutPayment Response Fields Field Description Token xs:string The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.
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.
6 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.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description TransactionID xs:string Unique transaction ID of the payment. Unique transaction ID of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Store this number for tracking the order. It represents an order placeholder in the PayPal system for a subsequent authorization by UATP.
6 146 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description FeeAmount ebl:BasicAmountType PayPal fee amount charged for the transaction. PayPal fee amount charged for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PaymentStatus ebl:PaymentStatusCodeType The status of the payment. It is one of the following values: The status of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: 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.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PendingReason ebl:PendingStatusCodeType Reason the payment is pending. It is one of the following values: Reason the payment is pending. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: none – No pending reason.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ReasonCode ebl:ReasonCodeType Reason for a reversal if TransactionType is reversal. It is one of the following values: Reason for a reversal if TransactionType is reversal. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values: none – No reason code. chargeback – A reversal has occurred on this transaction due to a chargeback by your buyer.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description ProtectionEligibili tyType xs:string Since version 64.4, the kind of seller protection in force for the transaction. It is one of the following values: Since version 64.4, the kind of seller protection in force for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description InstrumentDetails ns:InstrumentDetailsType Promotional instrument information. This field is introduced in API version 71.0. OfferDetails ns:OfferDetailsType Specific information for an offer. This field is introduced in API version 71.0. 6 UserSelectedOptions Fields Field Description ShippingCalculationM ode xs:string Describes how the options that were presented to the buyer were determined.
6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description LongMessage xs:string Payment error long message. ErrorCode xs:string Payment error code. SeverityCode xs:string Payment error severity code. ErrorParameters xs:string Application-specific error values indicating more about the error condition. SellerDetailsType Fields Field Description PayPalAccountID xs:string Unique identifier for the merchant.
ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 RiskFilterListType Fields Field Description ID xs:int Filter ID.
6 154 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation August 2012 SOAP API Developer Reference
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.
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 156 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.
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.
8 GetPalDetails API Operation GetPalDetails Response Message G e t P a l D e ta i l s R e s p o n s e M e s s a g e NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. GetPalDetails Response Fields 158 Field Description Pal xs:string PayPal-assigned merchant account number.
GetPalDetails API Operation GetPalDetails Response Message Field Description Locale xs:string Country code representing the merchant’s default locale.
8 160 GetPalDetails API Operation GetPalDetails Response Message August 2012 SOAP API Developer Reference
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.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message GetTransactionDetails Response Message 162 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.
GetTransactionDetails API Operation GetTransactionDetails Response Message SOAP API Developer Reference August 2012 9 163
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.
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.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message NOT E : 166 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
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 168 Field Description PaymentTransaction Details Wrapper structure.
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.
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 (,).
GetTransactionDetails API Operation GetTransactionDetails Response Message 9 ReceiverInfoType Fields Field Description Business xs:string Details about a single transaction. This field is not application for point-of-sale transactions. Receiver xs:string Primary email address of the payment recipient (the merchant). If you are the recipient of the payment and the payment is sent to your non-primary email address, the value of Receiver is still your primary email address.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description Address ns:AddressType Buyer’s shipping address information. PayerName Fields Field Description Salutation xs:string Buyer’s salutation. Character length and limitations: 20 single-byte characters FirstName ebl:PersonNameType Buyer’s first name. Character length and limitations: 25 single-byte characters MiddleName ebl:NameUser Buyer’s middle name.
GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description 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. Character length and limitations: 40 single-byte characters StateOrProvince xs:string State or province. Required for U.S. addresses only.
9 GetTransactionDetails API Operation GetTransactionDetails Response Message 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.
GetTransactionDetails API Operation GetTransactionDetails Response Message 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 (,).
9 176 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.
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.
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.
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.
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.
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.
9 182 GetTransactionDetails API Operation GetTransactionDetails Response Message August 2012 SOAP API Developer Reference
10 ManagePendingTransactionStatus 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.
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 184 Field Description TransactionID The transaction ID of the transaction whose payment has been denied or accepted.
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.
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.
Recurring Payments and Reference Transactions API Operations 12 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.
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.
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.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation NOT E : 190 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
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.
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.
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.
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.
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.
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 (.
12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation AddressType (Shipping) Fields 198 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.
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.
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.
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.
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.
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.
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.
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.
12 206 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.
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.
12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation NOT E : 208 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
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.
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.
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.
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.
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.
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.
12 216 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails 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.
Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation 12 M a n a g e R e c u r r i n g P a y m e n ts P r o f i l e Sta t u s A P I O p e r a t i o n The ManageRecurringPaymentsProfileStatus API operation cancels, suspends, or reactivates a recurring payments profile. ManageRecurringPaymentsProfileStatus Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
12 Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus 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 218 Field Description ProfileID xs:string Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.
Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation 12 B i l l O u ts ta n d i n g A m o u n t A P I O p e r a t i o n The BillOutstandingAmount API operation bills the buyer for the outstanding balance associated with a recurring payments profile. 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.
12 Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation Field Description Amount cc:BasicAmountType (Optional) The amount to bill. The amount must be less than or equal to the current outstanding balance of the profile. If no value is specified, PayPal attempts to bill the entire outstanding balance amount. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 UpdateRecurringPaymentsProfile API Operation The UpdateRecurringPaymentsProfile API operation updates a recurring payments profile. UpdateRecurringPaymentsProfile Request Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation NOT E : 222 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
12 224 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.
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.
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).
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.
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.
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.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description CreditCardNumber xs:string (Required) Credit card number. Character length and limitations: Numeric characters only with no spaces or punctutation. The string must conform with modulo and length required by each credit card type. ExpMonth xs:int (Required) Credit card expiration month.
Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description LastName ns:PersonNameType (Required) Buyer’s last name. Character length and limitations: 25 single-byte characters Address ns:AddressType (Required) Buyer’s billing address information. 12 AddressType Fields Field Description Street1 xs:string (Required) First street address.
12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. UpdateRecurringPaymentsProfile Response Fields 232 Field Description ProfileID xs:string Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation 12 SetCustomerBillingAgreement API Operation The SetCustomerBillingAgreement API operation initiates the creation of a billing agreement. NOT E : 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.
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.
Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description LocaleCode xs:string (Optional) Locale of pages displayed by PayPal during checkout.
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.
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”.
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.
Recurring Payments and Reference Transactions API Operations CreateBillingAgreement API Operation 12 CreateBillingAgreement API Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation. CreateBillingAgreement Response Fields Field Description BillingAgreementID xs:string Identification number of the billing agreement.
12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation G e t B i l l i n g A g r e e m e n t C u s t o m e r D e ta i l s A P I O p e r a t i o n 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.
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.
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 242 Field Description PayerInfo ns:PayerInfoType Information about the buyer such as the buyer’s name, email address, and country of residence.
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.
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 244 Field Description AddressStatus ebl:AddressStatusTypeCode Status of street address on file with PayPal.
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.
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”.
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.
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 248 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.
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.
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.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : 252 Not all fields shown are available for use. Use only the fields described in the documentation.
Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation SOAP API Developer Reference August 2012 12 253
12 254 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.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description IPAddress xs:string (Optional) IP address of the buyer’s browser. NOTE: PayPal records this IP addresses as a means to detect possible fraud. Character length and limitations: 15 single-byte characters, including periods, for example, 255.255.255.255 ReqConfirmShipping Whether you require that the buyer’s shipping address on file with PayPal be a confirmed address.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation AddressType (Shipping) Fields 258 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.
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.
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.
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).
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.
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.
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 264 Field Description Salutation xs:string (Optional) Buyer’s salutation.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation NOT E : 266 Not all fields shown are available for use. Use only the fields described in the documentation.
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.
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.
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.
12 270 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description FeeAmount ebl:BasicAmountType PayPal fee amount charged for the transaction. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. 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 (,).
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.
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.
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.
12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation RiskFilterListType Fields 274 Field Description ID xs:int Filter ID.
13 RefundTransaction API Operation The RefundTransaction API operation issues a refund to the PayPal account holder associated with a transaction.
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. Character length and limitations: 17 single-byte alphanumeric characters InvoiceID xs:string (Optional) Your own invoice or tracking number.
RefundTransaction API Operation RefundTransaction Request Message Field Description RefundSource ebl:RefundSourceCodeType (Optional)Type of PayPal funding source (balance or eCheck) that can be used for auto refund. It is one of the following values: any – The merchant does not have a preference. Use any available funding source. default – Use the merchant’s preferred funding source, as configured in the merchant’s profile. instant – Use the merchant’s balance as the funding source.
13 RefundTransaction API Operation RefundTransaction Response Message Field Description TerminalID xs:string (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. RefundTransaction Response Message NOT E : Not all fields shown are available for use. Use only the fields described in the documentation.
RefundTransaction API Operation RefundTransaction Response Message Field Description FeeRefundAmount ebl:BasicAmountType Transaction fee refunded to original recipient of payment. Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
13 RefundTransaction API Operation RefundTransaction Response Message 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.
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.
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.
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.
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.
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.
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”).
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.
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 10101 This API Temporarily Unavailable This API is temporarily unavailable. Please try later.
API Error Codes Validation Errors Error Code Short Message Long Message 81114 Missing Parameter LocaleCode : Required parameter missing 81115 Missing Parameter PaymentAction : Required parameter missing 81116 Missing Parameter Email : Required parameter missing 81117 Missing Parameter Token : Required parameter missing 81118 Missing Parameter PayerID : Required parameter missing 81119 Missing Parameter ItemAmt : Required parameter missing 81120 Missing Parameter ShippingAmt : Require
A 290 API Error Codes Validation Errors Error Code Short Message Long Message 81145 Missing Parameter EndDate : Required parameter missing 81146 Missing Parameter MPID : Required parameter missing 81147 Missing Parameter CreditCardType : Required parameter missing 81148 Missing Parameter User : Required parameter missing 81149 Missing Parameter Pwd : Required parameter missing 81150 Missing Parameter Version : Required parameter missing 81200 Missing Parameter Amt : Invalid paramet
API Error Codes DirectPayment API Errors Error Code Short Message Long Message 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 Parameter Street2 : Invalid parameter 81239 Invalid Parameter City : Invalid parameter 81243 Invalid Parameter RefundTyp
A API Error Codes DirectPayment API Errors Error Code 292 Short Message Long Message Corrective Action 10418 Transaction refused The currencies of the shopping because of an invalid cart amounts must be the same. argument. See additional error messages for details. 10426 Transaction refused Item total is invalid. because of an invalid argument. See additional error messages for details. 10427 Transaction refused Shipping total is invalid. because of an invalid argument.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10507 Invalid Configuration This transaction cannot be processed. Please contact PayPal Customer Service. Your PayPal account is restricted. Contact PayPal for more information. 10508 Invalid Data This transaction cannot be processed. Please enter a valid credit card expiration date. The expiration date must be a two-digit month and four-digit year.
A 294 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10535 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is invalid. 10536 Invalid Data This transaction cannot be processed. The merchant entered an invoice ID that is already associated with a transaction by the same merchant. By default, the invoice ID must be unique for all transactions.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10548 Invalid Configuration This transaction cannot be processed. The merchant’s account is not able to process transactions. The merchant account attempting the transaction is not a business account at PayPal. Check your account settings. 10549 Invalid Configuration This transaction cannot be processed. The merchan’s account is not able to process transactions.
A 296 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10564 Gateway Decline This transaction cannot be processed. There was a problem processing this transaction. 10565 Merchant country unsupported The merchant country is not supported. 10566 Credit card type unsupported The credit card type is not supported. 10567 Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10708 Invalid Data There’s an error with this transaction. Please enter a complete billing address. There was a problem with a particular field in the address. The long error message tells you which field is invalid. 10709 Invalid Data There’s an error with this transaction. Please enter an address1 in the billing address. There was a problem with a particular field in the address.
A 298 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10717 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. 10718 Invalid Data There’s an error with this transaction. Please enter a valid city and state in the billing address.
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. 10728 Invalid Data There’s an error with this transaction. Please enter a city in the shipping address. There was a problem with a particular field in the address.
A 300 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10744 Invalid Data This transaction cannot be processed. Please enter a valid country 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. 10745 Invalid Data This transaction cannot be processed. Please enter a valid country code in the shipping address.
API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10759 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The transaction was declined by PayPal. Contact PayPal for more information. 10760 Invalid Configuration This transaction cannot be processed. The country listed for your business address is not currently supported.
A API Error Codes DirectPayment API Errors Error Code 302 Short Message Long Message Corrective Action 12001 Transaction is not compliant due to missing or invalid 3-D Secure authentication values. Transaction is not compliant due to missing or invalid 3-D Secure authentication values. Check ECI, ECI3DS, CAVV, XID fields. 15001 Gateway Decline This transaction cannot be processed.
API Error Codes SetExpressCheckout API Errors A SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message 10001 ButtonSource value truncated. The transaction could not be loaded 10001 Internal Error Internal Error 10003 Missing argument. OtherPaymentMethodID is missing. 10003 Missing argument. OtherPaymentMethodLabel is missing. 10003 Missing argument. OtherPaymentMethodType is missing. 10003 Missing argument.
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 eBay buyer feedback overall positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay buyer feedback overall negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
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 total negative count. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback recent positive count. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A 306 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10010 Invalid Invoice Non-ASCII invoice id is not supported. 10101 Option not supported. Express Checkout temporarily unavailable. Please try later. 10102 PaymentAction of Order Temporarily Unavailable PaymentAction of Order is temporarily unavailable. Please try later or use other PaymentAction. 10103 Please use another Solution Type. Your Solution Type is temporarily unavailable.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error... 10411 This Express Checkout session has expired. This Express Checkout session has expired. Token value is no longer valid. If you receive this error, you must return your buyer to PayPal to approve the use of PayPal again. Display an error message to inform the buyer that the transaction expired, and provide a button to return to PayPal.
A API Error Codes SetExpressCheckout API Errors Error Code 308 Short Message Long Message Correcting This Error... 10415 Transaction refused because of an invalid argument. See additional error messages for details. A successful transaction has already been completed for this token. PayPal allows a token only once for a successful transaction.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10432 Transaction refused because of an invalid argument. See additional error messages for details Invoice ID value exceeds maximum allowable length. 10433 Transaction refused because of an invalid argument. See additional error messages for details Value of Order Description has been truncated. 10434 Transaction refused because of an invalid argument.
A API Error Codes SetExpressCheckout API Errors Error Code 310 Short Message Long Message 10457 Error occurred in communicating to eBay eBay API creation error 10458 Error occurred in communicating to eBay eBay API unknown failure 10459 Error occurred in communicating to eBay eBay API failure 10460 Error occurred in communicating to eBay Parsing error 10461 Error occurred in communicating to eBay Item number invalid, removed, or unavailable 10462 Error occurred in communicating to eBay
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 10474 Invalid Data This transaction cannot be processed. The country code in the shipping address must match the buyer's country of residence 10475 Transaction refused because of an invalid argument.
A API Error Codes SetExpressCheckout API Errors Error Code 312 Short Message Long Message 10729 Shipping Address State Empty The field Shipping Address State is required 10730 Shipping Address Postal Code Empty The field Shipping Address Postal Code is required 10731 Shipping Address Country Empty The field Shipping Address Country is required 10736 Shipping Address Invalid City State Postal Code A match of the Shipping Address City, State, and Postal Code failed.
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 11802 Invalid Data You cannot pass both the new and deprecated Custom parameter. 11803 Invalid Data You cannot pass both the new and deprecated Invoice ID parameter. 11804 Invalid Data You cannot pass both the new and deprecated order description. 11805 Invalid Data You cannot pass both the new and deprecated order total or amount parameters.
A API Error Codes SetExpressCheckout API Errors Error Code 314 Short Message Long Message Invalid callback timeout The callback timeout is is zero; you must specify a longer timeout Line items missing Line items are required when specify a callback URL for flate rate shipping options Callback URL is too long The callback URL must not exceed 1,024 characters Multiple default shipping options specified You can only specify one default shipping option at a time No default shipping option specifie
API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message 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-rate shipping option 11830 Insurance amount is missing Insurance amount is missing; you have offered insurance but have not specified
A API Error Codes SetExpressCheckout API Errors Error Code 316 Short Message Long Message 12208 eBay item amount does not match Express Checkout API item amount. eBay item amount must match Express Checkout API item amount.
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.
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 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. 10410 Invalid token Invalid token. 10411 This Express Checkout session has expired. This Express Checkout session has expired.
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. Invalid item URL. 10004 Transaction refused because of an invalid argument. See additional error messages for details. SellerRegistrationDate is invalid. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid eBay seller feedback overall positive count.
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 payment hold risk. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Multiple eBay order IDs not allowed.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10416 Transaction refused because of an invalid argument. See additional error messages for details. You have exceeded the maximum number of payment attempts for this token. 10417 Transaction cannot complete. The transaction cannot complete successfully. Instruct the customer to use an alternative payment method. 10418 Transaction refused because of an invalid argument.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 322 Short Message Long Message 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. 10431 Item amount is invalid. Item amount is invalid. 10432 Transaction refused because of an invalid argument.
API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message 10445 This transaction cannot be processed at this time. Please try again later. This transaction cannot be processed at this time. Please try again later. 10446 Unconfirmed email A confirmed email is required to make this API call. 10474 Invalid Data This transaction cannot be processed. The country code in the shipping address must match the buyer’s country of residence.
A API Error Codes DoExpressCheckoutPayment API Errors Error Code 324 Short Message Long Message 10728 Shipping Address City Empty The field Shipping Address City is required 10729 Shipping Address State Empty The field Shipping Address State is required 10730 Shipping Address Postal Code Empty The field Shipping Address Postal Code is required 10731 Shipping Address Country Empty The field Shipping Address Country is required 10736 Shipping Address Invalid City State Postal Code A match
API Error Codes DoExpressCheckoutPayment API Errors Error Code 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.
A 326 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.
API Error Codes Authorization and Capture API Errors A Authorization and Capture API Errors Authorization and Capture API Error Messages Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10004 Internal Error Invalid argument 10007 Permission denied You do not have permissions to make this API call 10009 Transaction refused Account is locked or inactive 10010 Transaction refused because of an invalid ar
A 328 API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10604 Authorization must include both buyer and seller. Authorization transaction cannot be unilateral. It must include both buyer and seller to make an auth. DoAuthorization Review the order to ensure customer and seller are both PayPal members. 10605 Unsupported currency. Currency is not supported.
API Error Codes Authorization and Capture API Errors Error Code Short Message Returned By API Call... Correcting This Error... 10615 Cannot reauth reauth. You can reauthorize only the original authorization, not a reauthorization. DoReauthorization Capture the reauthorization. 10616 Maximum number of reauthorization allowed for the auth is reached. Maximum number of reauthorization allowed for the auth is reached. DoReauthorization Capture or close the authorization.
A 330 API Error Codes Authorization and Capture API Errors Error Code Short Message Long Message Returned By API Call... Correcting This Error... 10625 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the maximum amount for a single transaction. DoAuthorization DoCapture DoReauthorization Reattempt the request with a lower amount. 10626 Risk Transaction refused due to risk model.
API Error Codes GetTransactionDetails API Errors A GetTransactionDetails API Errors GetTransactionDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10004 Transaction refused because of an invalid argument. See additional error messages for details. Store ID is required if Terminal ID is specified.
A API Error Codes TransactionSearch API Errors Error Code 332 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Receipt id is not valid 10004 Transaction refused because of an invalid argument. See additional error messages for details. Payer email is invalid 10004 Transaction refused because of an invalid argument. See additional error messages for details.
API Error Codes RefundTransaction API Errors A RefundTransaction API Errors RefundTransaction API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 Internal Error Warning an internal error has occurred. The transaction id may not be correct 10001 Internal Error The transaction could not be loaded. 10002 Restricted account Account is restricted. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error...
API Error Codes RefundTransaction API Errors Error Code Short Message Long Message 10009 Transaction refused The account for the counterparty is locked or inactive 10009 Transaction refused This transaction already has a chargeback filed 10009 Transaction refused You have not filled out the Direct Debit Instruction 10011 Invalid transaction id value Transaction refused because of an invalid transaction id value 10755 Unsupported currency Currency is not supported 11603 Conflict with prio
A API Error Codes MassPay API Errors MassPay API Errors MassPay API Errors 336 Error Code Short Message Long Message 10001 Invalid account number. The transaction failed as a result of an invalid credit card number. Check the number or attempt with another card. 10001 Internal Error Internal Error 10001 Internal Error The transaction could not be loaded 10001 ButtonSource value truncated. The transaction could not be loaded 10001 Transaction refused because of an invalid argument.
API Error Codes MassPay API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The amount is not a valid number 10004 Transaction refused because of an invalid argument. See additional error messages for details. The amount exceeds the max limit of a single mass pay item ~1 10004 Transaction refused because of an invalid argument. See additional error messages for details.
A API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10311 Unable to submit payment Unable to submit payments for masspay 10312 Masspay server error The masspay server has reported errors 10313 Masspay Invalid Data The masspay input file includes invalid data 10314 Masspay input parse error The input to the masspay server is incorrect. Please make sure that you are using a correctly formatted input.
API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10004 Cart item calculation mismatch. Cart item calculation mismatch. The regular non-trial billing period amount is different than the sum of the amounts for each item in the cart. Scenario: When the regular nontrial billing period amount is different than the sum of the amounts for each item in the cart. 10004 Tax calculation mismatch. Tax calculation mismatch.
A 340 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10511 Invalid Data This transaction cannot be processed. The merchant selected an value for the PaymentAction field that is not supported. 10512 Invalid Data This transaction cannot be processed. Please enter a first name. The first name of the buyer is required for this merchant. 10513 Invalid Data This transaction cannot be processed. Please enter a last name.
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. There was a problem with a particular field in the address.
A API Error Codes Recurring Payments Errors Error Code 342 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 tr
API Error Codes Recurring Payments Errors Error Code Short Message Long Message 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 payments feature is not currently available; try again later 11548 Invalid currency code Invalid currency c
A API Error Codes Recurring Payments Errors Error Code 344 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 increas
API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message 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 13122 Transaction refused Transaction violates PayPal use 13701 Invalid Data Item Category value is invalid. Only Digital or Physical are allowed.
A API Error Codes SetCustomerBillingAgreement Errors Error Code 346 Short Message Long Message Additional Information 10436 Transaction refused because of an invalid argument. See additional error messages for details. PageStyle value exceeds maximum allowable length. PageStyle tag is too long. 10437 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length.
API Error Codes GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 11453 Reference transactions temporarily unavailable. Reference transaction feature not currently available; try again later Feature not enabled because system is running in standin mode. Warning only.
A API Error Codes UpdateBillingAgreement Errors Error Code Short Message Long Message Additional Information 11455 Buyer did not accept billing agreement Buyer did not accept billing agreement Buyer has not agreed to the billing agreement. 11456 A successful Billing Agreement has already been created for this token. Transaction refused because of an invalid argument. See additional error messages for details. Token has already been used to create a billing agreement.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10211 Invalid billing agreement ID Invalid transaction or billing agreement ID; could not find Billing Agreement in database 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid ReferenceID field is empty.
A API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid payment type argument 10009 Transaction refused The account for the counterparty is locked or inactive Merchant is locked/close/restricted. 10010 Invalid Invoice Non-ASCII invoice id is not supported Non-ASCII characters are used in InvoiceID field.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10400 Transaction refused because of an invalid argument. See additional error messages for details. Order total is missing. TotalOrder amount is missing. 10401 Transaction refused because of an invalid argument. See additional error messages for details. Order total is invalid. TotalOrder amount is invalid. 10402 Authorization only is not allowed for merchant.
A API Error Codes DoReferenceTransaction Errors Error Code 352 Short Message Long Message Additional Information 10426 Transaction refused because of an invalid argument. See additional error messages for details. Item total is invalid. ItemTotal amount is invalid. 10427 Transaction refused because of an invalid argument. See additional error messages for details. Shipping total is invalid. ShippingTotal amount is invalid. 10428 Transaction refused because of an invalid argument.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 10441 Transaction refused because of an invalid argument. See additional error messages for details. The NotifyURL element value exceeds maximum allowable length. NotifyURL field is too long; maximum length for notify URL is 2048. 10442 ButtonSource value truncated. The ButtonSource element value exceeds maximum allowable length. ButtonSource field is too long; maximum length is 32.
A API Error Codes DoReferenceTransaction Errors Error Code 354 Short Message Long Message Additional Information 10725 Shipping Address Country Error There was an error in the Shipping Address Country field Shipping address error in country field. 10727 Shipping Address1 Empty The field Shipping Address1 is required Shipping address error in address1 field. 10728 Shipping Address City Empty The field Shipping Address City is required Shipping address error in city field.
API Error Codes DoReferenceTransaction Errors Error Code Short Message Long Message Additional Information 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Reference transaction is not associated with a billing agreement. 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Reference id either not found or could not be decrypted.
A API Error Codes AddressVerify API Errors AddressVerify API Errors AddressVerify API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid email format. 10004 Transaction refused because of an invalid argument. See additional error messages for details. Invalid street format 10004 Transaction refused because of an invalid argument. See additional error messages for details.
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.
B 358 Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 CHRISTMAS ISLAND * CX * COCOS (KEELING) ISLANDS CC COLOMBIA CO COOK ISLANDS CK COSTA RICA CR CYPRUS CY CZECH REPUBLIC CZ DENMARK DK DJIBOUTI DJ DOMINICA
Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 HONDURAS HN HONG KONG HK HUNGARY HU ICELAND IS INDIA IN INDONESIA ID I
B 360 Countries and Regions Supported by PayPal Country or Region Country or Region Code JAPAN JP JERSEY JE JORDAN JO KAZAKHSTAN KZ KIRIBATI KI KOREA, REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LATVIA LV LESOTHO LS LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA MK MADAGASCAR MG MALAWI MW MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX MICRONESIA, FEDERATED STATES OF FM MOLDOVA, REPUBLI
Countries and Regions Supported by PayPal Country or Region Country or Region Code MOROCCO MA MOZAMBIQUE MZ NAMIBIA NA NAURU NR NEPAL * NP * NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PALAU PW PALESTINE PS PANAMA PA PARAGUAY PY PERU PE PHILIPPINES PH PITCAIRN PN POLAND PL PORTUGAL PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO
B 362 Countries and Regions Supported by PayPal Country or Region Country or Region Code 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 SOUTH SANDWICH ISLANDS GS SPAIN ES SURINAME SR SVALBARD AND
Countries and Regions Supported by PayPal Country or Region Country or Region Code TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS, BRITISH VG VIRGIN ISLANDS, U.S.
B 364 Countries and Regions Supported by PayPal August 2012 SOAP API Developer Reference
C State and Province Codes Canadian Province or U.S.
C 366 State and Province Codes Canadian Province or U.S.
State and Province Codes Canadian Province or U.S.
C 368 State and Province Codes August 2012 SOAP API Developer Reference
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.
D Currency Codes Currency Currency Code 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.
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.
E AVS and CVV2 Response Codes AVS Response Codes AVS Code Meaning Matched Details X Exact match Address and nine-digit ZIP code Y Yes Address and five-digit ZIP Z ZIP Five-digit ZIP code (no Address) All others Error Not applicable Related information: DoDirectPayment Response Fields AVS Response Codes for Maestro AVS Code Meaning Matched Details 0 All the address information matched. All information matched 1 None of the address information matched.
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
E 374 AVS and CVV2 Response Codes CVV2 Response Codes August 2012 SOAP API Developer Reference
About Previous Versions of the API Previous versions of the API can still be used; however, PayPal recommends using the latest version whenever possible. Unless specifically specified, API operations default to the latest version. What’s New in Version 92.0 Updated for 92.0. Added new MsgSubID field for the following APIs for both requests and responsees: RefundTransaction; DoReferenceTransaction; DoAuthorization; and DoCapture. What’s New in Version 89.0 Updated for 89.0.
What’s New in Version 84.0 New Field in RefundTransaction Response Field Description RefundInfo ebl:RefundInfoType Contains refund payment status information. This field is available since version 84.0. New RefundInfoType in RefundTransaction Response Field Description RefundStatus xs:PaymentStatusCodeType Status of the refund. It is one of the following values: instant delayed This field is available since version 84.0.
What’s New in Version 82.0 New Field in DoDirectPaymentResponse Field Description PaymentAdviceCode xs:string Response code from the processor when a recurring transaction is declined. For details on the meanings of the codes, see https://merchant.paypal.com/us/cgi-bin/?&cmd=_rendercontent&content_ID=merchant/cc_compliance_error_codes This field is available since version 84.0. What’s New in Version 82.
What’s New in Version 82.0 New Fields in RefundTransaction Request Field Description MerchantStoreDetails ns:MerchantStoreDetailsType (Optional) Information about the merchant store. This field is available since version 82.0. RetryUntil xs:dateTime (Optional) Maximum time until you must retry the refund. NOT E : This field does not apply to point-of-sale transactions. This field is available since version 82.0.
What’s New in Version 80.0 Field Description TerminalID xs:string (Optional) ID of the terminal. Character length and limitations: 50 single-byte characters This field is available since version 82.0. What’s New in Version 80.0 New Field in PaymentDetailsType in DoDirectPayment Request Field Description Recurring ns:RecurringFlagType (Optional) Flag to indicate a recurring transaction. It is one of the following values: Any value other than Y – This is not a recurring transaction (default).
What’s New in Version 74.0 What’s New in Version 74.0 New Behavior of DoExpressCheckoutPayment By default, the DoExpressCheckoutPayment API operation is idempotent for all API callers. You can call DoExpressCheckoutPayment up to a maximum of 10 times, and it returns the same result. The exceptions are when DoExpressCheckoutPayment generates an error or the token expires. This functionality only works with version 74.0 or greater.
What’s New in Version 72.0 New TaxIdDetailsType Structure in SetExpressCheckout Request TaxIdDetailsType Fields Field Description TaxIdType New field xs:string The buyer’s tax ID type. This field is required for Brazil and used for Brazil only. For Brazil use only: The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses. TaxId New field xs:string The buyer’s tax ID. This field is required for Brazil and used for Brazil only.
What’s New in Version 69 What’s New in Version 69 New PaymentDetailsItemType Structure in CreateRecurringPaymentsProfile Request PaymentDetailsItemType Fields Field Description ItemCategory New field ns:ItemCategoryType Indicates whether the item is digital or physical goods. For digital goods, this field is required and you must set it to Digital to get the best rates. It is one of the following values: Digital Physical Name New field xs:string Item name.
What’s New in Version 69 Field Description Tax New field ebl:BasicAmountType (Optional) Item sales tax. 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 (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
What’s New in Version 66 What’s New in Version 66 Changes to PaymentDetailsType in SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsType Fields Field Description ItemTotal ebl:BasicAmountType Sum of cost of all items in this order. For digital goods, this field is required. N O TE : PaymentAction You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. ebl:PaymentActionCodeType How you want to obtain payment.
What’s New in Version 66 Field Description Amount ebl:BasicAmountType Cost of item. For digital goods, this field is required. N O TE : You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
What’s New in Version 66 386 August 2012 SOAP API Developer Reference
Revision History Date Description 10 August 2012 Maintenance release. Added CVV2 response codes E and I for Visa, Mastercard, Discover and American Express. 7 August 2012 Maintenance release. New 10486 error code added for redirects when the process declines the transaction: The transaction couldn’t be completed. Please redirect your customer to PayPal. 10 July 2012 Updated for 92.0.
Date Description 11 May 2010 Updated for 63.0. Added new NVP API fields to use in version 63.0 Express Checkout integrations. Deprecated old fields. Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation. Added ReverseTransaction API. 10 March 2010 Updated information for 62.0: Describes Express Checkout fields recommended to be used in applications that enable implementing parallel payments for a marketplace.
Date Description April 2007 Added Recurring Payments APIs: SetCustomerBillingAgreement, GetBillingAgreementCustomerDetails, and CreateRecurringPaymentsProfile. February 2007 Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs, changing some parameters to optional in DoDirectPayment, adding SHIPTOCOUNTRYCODE, and adding Switch/Solo codes for AVS and CVV2. December 2006 Updates for bug fixes. October 2006 First public release.
August 2012 SOAP API Developer Reference
Index A AcceptFilters response field 68, 152, 273 Action request field 183, 217 ActivationDetails request field 194 ActivationDetailsType request fields 197 AdditionalBilling Cycles request field 225 Address Owner response field 172, 215 Address request field 59, 77, 88, 200, 231 Address response field 117, 172, 215, 243, 250 AddressOverride request field 89 AddressStatus response field 118, 172, 211, 216, 244 AddressType (Shipping) request fields 65, 95, 130, 198, 227, 258 AddressType (Shipping) response
Index BillOutstandingAmount request fields 219 BillOutstandingAmount request message 219 BillOutstandingAmount response fields 220 BillOutstandingAmount response message 220 BrandName request field 93 Brazilian Real 369 BRL 369 Business response field 171 ButtonSource request field 63, 130, 133, 260 BuyerDetails request field 93 BuyerDetailsType request fields 102 BuyerEmail request field 91, 236 BuyerEmailOpti nEnable request field 94 BuyerId request field 102 BuyerID response field 180 BuyerMarketingEmai
Index D Danish Krone 369, 370 dateÚtime formats 24 DenyFilters response field 68, 152, 273 Description request field 64, 99, 135, 194, 202, 225, 261, 382, 384 Description response field 69, 122, 153, 209, 274 Discover AVS response codes 371 Discover CVV2 response codes 373 DKK 369, 370 Do Reauthorization request fields 45 Do Reauthorization response fields 45 DoAuthorization API operation 40 DoAuthorization request fields 40 DoAuthorization request message 40 DoAuthorization response fields 41 DoAuthorizat
Index FirstName response field 117, 172, 215, 243, 250 FlatR ateShippingOptions request field 88 FMFDetails response field 68, 143, 150, 268 FMFDetailsType response fields 68, 152, 273 Forint 369, 370 FundingSourceDetails request field 93 FundingSourceDetailsType request fields 102 G GBP 369, 370 Get ExpressCheckout Details request fields 106 GetBalance API operation 155 GetBalance request fields 155 GetBalance request message 155 GetBalance response fields 156 GetBalance response message 156 GetBillingAg
Index ItemCategory 383 ItemCategory request field 101, 137, 202, 382 ItemCategory response field 123 ItemHeight request field 100, 137 ItemHeight response field 123 ItemLength request field 100, 136 ItemLength response field 123 ItemNumber request field 65, 101, 137, 262 ItemNumber response field 124 ItemTotal reque stfield 61 ItemTotal request field 96, 131, 259, 384 ItemTotal response field 119 ItemURL request field 100, 137 ItemWeight request field 100, 136 ItemWeight response field 123 ItemWidth reques
Index NetRefundAmount response field 279 New Zealand Dollar 369, 370 NextBillingDate response field 213 NOK 369, 370 Norwegian Krone 369, 370 NoShipping request field 88 Note request field 32, 49, 217, 220, 225 Note response field 115, 142 NoteT ext request field 98 NoteText request field 134 NoteText response field 122 NoteToBuyer request field 94 Noti fyURL request field 63 NotifyURL request field 98, 134, 260 NotifyURL response field 121 NotToBuyer request field 94 Number request field 64, 100, 136, 202
Index PaymentTransactionDetails response field 168 PaymentTransactionDetails response fields 170 PaymentType request field 104, 237 PaymentType response field 145, 174, 269 PayPalAccountID request field 101 PayPalAccountID response field 125, 152 PayPalAdjustment response field 115 PayPalToken response field 29 PendingFilters response field 68, 152, 273 PendingReason request field 280 PendingReason response field 43, 47, 148, 177, 272 Period response field 181 Peso 369 Philippine Peso 369 Phone request fie
Index S SalesTax response field 178 Salutation request field 60, 76, 200, 264, 284 Salutation response field 117, 172, 243, 250 ScheduleDetails request field 193 ScheduleDetailsType request fields 194 SecureMerchantAccountID response field 152 security 17 SEK 369, 370 SellerDetails request field 98, 134 SellerDetails response field 150 SellerDetailsType request fields 138 SellerID request field 138 SellerRegistrationDate request field 138 SellerUserName request field 138 service architecture 15 service end
Index SurveyQuestion request field 94, 130 SurveyQuestion response field 116 SurveyQuestionresponse field 170 Swedish Krona 369, 370 Swiss Franc 369, 370 T Taiwan New Dollar 369 Tax request field 64, 100, 136, 203, 262, 383 Tax response field 123 TaxAmount request field 74, 197, 226, 229 TaxAmount response field 146, 175, 213, 270 TaxId request field 104 TaxId response field 126 TaxIdDetails request field 102 TaxIdDetailsType request fields 104 TaxIdDetailsType response fields 126 TaxIdType request field
Index Z Zip request field 28 ZipMatch response field 29 Zloty 369, 370 400 August 2012 SOAP API Developer Reference
