Web Services API Reference For Professional Use Only Currently only available in English. A usage Professional Uniquement Disponible en Anglais uniquement pour l'instant.
PayPal Web Services API Reference © 2006 PayPal Inc. All rights reserved. PayPal and the PayPal logo are registered trademarks 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. PayPal (Europe) Ltd. is authorised and regulated by the Financial Services Authority in the United Kingdom as an electronic money institution.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Organization of This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Documentation Problems . . . . . . . .
Contents PayPal Web Services API Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Character Encoding, Data Types and Formats, and Currencies . . . . . . . . . . . . 31 API Overview By Business Function and Service Endpoint . . . . . . . . . . . . . . . 32 APIs to Exchange Funds or Display Information . . . . . . . . . . . . . . . . . . . . 33 Instant Payment Notification and the APIs. . . . . . . . . . . . . . . . . . . . . . . . 33 Chapter 3 Core eBL Request/Response Structures . .
Contents Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Chapter 6 Express Checkout API . . . . . . . . . . . . . . . . . . . . 65 SetExpressCheckout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Diagram of Set ExpressCheckout Types . . . . . . . . . . . . . . . . . . . . . . . . 66 SetExpressCheckoutRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 SetExpressCheckoutResponse . . . . . . . . . . . . . . . .
Contents RefundTransactionResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 Chapter 10 TransactionSearch API . . . . . . . . . . . . . . . . . . 103 Diagram of TransactionSearch Types . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 TransactionSearchRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104 Fields . . . . . . . . . . . . . . . . . . . . . .
List of Tables Table 1.1 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Table 1.1 PayPal Technical Documentation . . . . . . . . . . . . . . . . . . . . . 17 Table 2.1 Location of PayPal WSDL and XSD Files . . . . . . . . . . . . . . . . . 22 Table 2.2 Basic PayPal API Set-up Concepts and Terminology . . . . . . . . . . . 22 Table 2.3 RequesterCredentials Authentication Elements in SOAP Header . . . . . 24 Table 2.4 SOAP Service Endpoints . . . . . . . . . . . .
List of Tables 8 Table 5.9 DoDirectPaymentResponse Fields . . . . . . . . . . . . . . . . . . . . . 62 Table 5.10 AVS Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Table 5.11 CVV2 Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Table 6.1 SetExpressCheckoutRequest Fields . . . . . . . . . . . . . . . . . . . . 67 Table 6.2 Address (Shipping Address): AddressType Elements . . . . . . . . . . . 71 Table 6.3 SetExpressCheckoutResponse Fields . . . . .
List of Tables Web Services API Reference July 2006 9
List of Tables 10 July 2006 Web Services API Reference
List of Figures Figure 2.1 PayPal Web Services High-level Diagram . . . . . . . . . . . 21 Figure 2.2 Diagram of SOAP Request Envelope . . . . . . . . . . . . . 26 Figure 3.1 Core eBL Types . . . . . . . . . . . . . . . . . . . . . . . 35 Figure 4.1 DoCapture Types . . . . . . . . . . . . . . . . . . . . . . 40 Figure 4.2 DoAuthorization Types Figure 4.3 DoVoid Types . . . . . . . . . . . . . . . . . . . . . . . . 47 Figure 4.4 DoReauthorization Types Figure 5.1 DoDirectPayment Types . . . .
List of Figures 12 July 2006 Web Services API Reference
Preface This Document This document, PayPal Web Services API Reference, which describes the PayPal Web Services Application Programming Interface (API) and service, replaces the edition issued March, 2006. Intended Audience This document is written for programmers familiar with Web Services application programming standards such as the Simple Object Access Protocol (SOAP), the Web Services Description Language (WSDL), and XML Schema Definition (XSD) language.
Preface Documentation Problems Typeface How Used serif italics A document title. A term being discussed or defined. For example: A file is a readable or writable stream of characters … Boolean values (not keywords). For example: The function returns true if it encounters an error. monospaced Pathnames or file names that appear in body text frames. Code-related names that appear in body text frames. Such names are used for functions, callbacks, arguments, data structures, and fields.
Preface Revision History Log in to your account at https://developer.paypal.com/ by entering your email address and password in the Member Log In box Click Help Center at the bottom of the box on the right side of the page. Click Email PayPal Technical Support. Complete the form. Revision History Revision history for PayPal Web Services API Reference. TABLE 1.1 Revision History Date Description July 2006 CardNumber field added to TransactionSearch API.
Preface Revision History 16 July 2006 Web Services API Reference
1 Overview of the PayPal Web Services API The PayPal Web Services API provides programmatic access to PayPal features and services. Developers can build custom applications, tools, and services that correspond to the same services and tools available through the main PayPal website, https://www.paypal.com/. Typical applications include searching for transactions, paying en masse, and making refunds. Get Started Quickly: Integration Center PayPal’s Integration Center at https://www.paypal.
Overview of the PayPal Web Services API Open Standards Background Information TABLE 1.1 PayPal Technical Documentation Guide Title Description Prerequisites Order Management Integration Guide Details Instant Payment Notification (IPN) and Payment Data Transfer (PDT) for automated receipt of payment information after payment completion. Details IPN HTML FORM variables and their meanings. Also includes information about Downloadable History Logs. Website Payments Standard Integration Guide https://www.
Overview of the PayPal Web Services API Web Services Standards Web Services Standards Web Services are an ongoing open standards effort. For the latest information about developments in Web Services, see the following site: http://www.webservices.org/ Cryptography The PayPal Web Services API uses public key infrastructure, specifically PKCS#12 and Privacy Enhanced Mail (PEM).
Overview of the PayPal Web Services API Cryptography 20 July 2006 Web Services API Reference
2 PayPal Web Services API Architecture The PayPal Web Services API provides programmatic access to PayPal features and services. Developers can build custom applications, tools, and services that correspond to the same services and tools available through the main PayPal website, https://www.paypal.com/. Typical applications include searching for transactions, paying en masse, and making refunds.
PayPal Web Services API Architecture Services Architecture business-object interfaces and network stubs from PayPal-provided WSDL and XSD files that specify the PayPal SOAP message structure, its contents, and the PayPal API service bindings. A business application works with data in the form of object properties to send and receive data by calling object methods.
PayPal Web Services API Architecture Services Architecture TABLE 2.2 Basic PayPal API Set-up Concepts and Terminology Term Definition API Certificate A PayPal-generated unique digital certificate file that you download from the PayPal website and use on the client computer to encrypt the HTTPS requests of your API calls to PayPal’s API server. An API certificate is suitable if you have complete control over your own web server.
PayPal Web Services API Architecture Services Architecture SOAP RequesterCredentials: Username, Password, Signature, and Subject For the security of your business, PayPal must verify that merchants or third-party developers are permitted to initiate a transaction before they make one. PayPal authenticates each request. If the request cannot be authenticated, a SOAP security fault is returned.
PayPal Web Services API Architecture SOAP Service Endpoints TABLE 2.3 RequesterCredentials Authentication Elements in SOAP Header Element Value Description authorizing_ account_ emailaddress The email address of a third-party for whom you are sending requests to the PayPal Web Services API. Your API username must have been granted permission by this third-party to make any particular PayPal API request.
PayPal Web Services API Architecture SOAP Implementation SOAP Implementation This section contains information about the PayPal Web Services SOAP implementation. 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.
PayPal Web Services API Architecture SOAP Implementation EXAMPLE 2.1 General Structure of PayPal API SOAP Request 1. 2. 8. 9.
PayPal Web Services API Architecture SOAP Implementation TABLE 2.5 Annotation of Generic SOAP Request Lines Comment 22 The number of the PayPal Web Services API version is required on each SOAP request. 24 For details about required and optional elements and values for specific requests, see the description of individual APIs. Response Structure The following is an annotated description of the structure of a SOAP response from the PayPal Web Services API. EXAMPLE 2.
PayPal Web Services API Architecture SOAP Implementation TABLE 2.6 Annotation of Generic SOAP Response Lines Comment 22 and 31 The specific_api_name_Response start and end elements. 23 Each API response contains a timestamp with its date and time in UTC/GMT. 24 The element contains the string Success after the corresponding request has been successfully processed. (For a complete list of possible returned strings, see “AbstractResponseType” on page 36.
PayPal Web Services API Architecture PayPal Web Services API Definitions 2005-02-09T21:51:26Z Failure Authentication/Authorization Failed Username/Password is incorrect
PayPal Web Services API Architecture PayPal Web Services API Definitions z Backward compatibility: The PayPal API is versioned so that business applications are backward compatible when new elements are introduced to the server-side schema. N O T E : eBL defines many structures that are specific to processing auctions. PayPal’s Web Services schema includes these definitions to maintain compatibility with eBay’s Web Services and for possible future joint use of Web Services across both eBay and PayPal.
PayPal Web Services API Architecture PayPal Web Services API Definitions The core currency amount data type is derived from string, and all currency amount elements have the following structure. The currencyID attribute is required. ns:BasicAmountType (The element name Amount is an example; actual element names can vary depending on the specific API.
PayPal Web Services API Architecture PayPal Web Services API Definitions TABLE 2.8 API Overview by Business Function and Service Endpoint Business Function SOAP Request/Response Production (Live) Endpoint Test (Sandbox) Endpoint: GetTransaction Details API GetTransactionDetailsReq uest GetTransactionDetailsRes ponse api.paypal.com/2.0/ api-3t.paypal.com/2.0/ api.sandbox.paypal.com/2.0/ MassPay API MassPayRequest MassPayResponse api.paypal.com/2.0/ api-3t.paypal.com/2.0/ api.sandbox.paypal.com/2.
PayPal Web Services API Architecture PayPal Web Services API Definitions 34 July 2006 Web Services API Reference
3 Core eBL Request/Response Structures The PayPal Web Services API is built on core structures from the eBL schema that define required elements in all SOAP requests and responses: z AbstractRequestType z AbstractResponseType Diagram of core eBL Types The following diagram represents the composition of the AbstractRequestType and AbstractResponseType elements. FIGURE 3.
Core eBL Request/Response Structures AbstractRequestType A b s t r a c t R e q u e s t Ty p e AbstractRequestType is the base type definition of all PayPal Web Services SOAP requests. IMPO RTANT: You must set the value of the Version element for all requests to any PayPal Web Services API. Fields TABLE 3.1 AbstractRequestType Fields Element Version Description Data Type Allowable Values Required? A string representing the version of the request payload schema xs:string 2.
Core eBL Request/Response Structures AbstractResponseType TABLE 3.2 AbstractResponseType Fields Element Description Data Type Possible Values Ack A token representing the application-level acknowledgement code. Contains one of the following enumerated values: Success: Request processing succeeded Failure: Request processing failed SuccessWithWarning: Request processing completed successfully but with some warning information that could be useful for the requesting application to process or record.
Core eBL Request/Response Structures AbstractResponseType 38 July 2006 Web Services API Reference
4 Authorization & Capture API The Authorization & Capture API consists of individual requests and responses, as shown below. TABLE 4.1 Authorization & Capture API Names, Purposes, and Types of Authorization Used With Type of Authorization API Purpose 1. DoCapture Settle an order or previously authorized transaction and obtain payment for either the complete amount or any portion of it. Order and Basic 2. DoAuthorization Authorize an order that can be fulfilled over 29 days. Order only 3.
Authorization & Capture API DoCapture DoCapture DoCaptureRequest is your request to completely or partially settle an order, an authorization, or reauthorization. N O T E : DoCaptureRequest is for use with both basic and order authorizations. Diagram of DoCapture Types The following diagram represents the composition of the DoCaptureRequestType and DoCaptureResponseType elements. Elements required in the request are marked with an asterisk. FIGURE 4.
Authorization & Capture API DoCapture DoCaptureRequest Request to capture funds from a PayPal member’s account. Fields TABLE 4.2 DoCaptureRequest Fields Element Description Data Type Allowable Values Required? Authorization ID The authorization identification number of the payment you want to capture. This can be an order number, an order authorization number, or a rauthorization number. Character length and limits: 19 single-byte characters maximum xs:string See description.
Authorization & Capture API DoCapture DoCaptureResponse Response to DoCaptureRequest. Fields TABLE 4.3 DoCaptureResponse Fields Element Description Data Type Possible Values Authorization ID The authorization identification number you specified in the request. Character length and limits: 19 single-byte characters maximum xs:string See description. PaymentInfo Information about the payment. ebl:PaymentInfo See Table 4.4 on page 42. Type TABLE 4.
Authorization & Capture API DoCapture TABLE 4.4 Response: PaymentInfoType Elements Element Description Data Type Possible Values TaxAmount Tax charged on the transaction ebl:BasicAmount Type xs:string Transactionspecific ExchangeRate Exchange rate if a currency conversion occurred. Relevant only if you are billing in the customer’s non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer’s account.
Authorization & Capture API DoCapture TABLE 4.4 Response: PaymentInfoType Elements Element Description Data Type Possible Values PendingReason N O T E : PendingReason is returned in the ebl:PendingStatus CodeType xs:token none address echeck intl multi-currency verify other response only if PaymentStatus is Pending.
Authorization & Capture API DoAuthorization DoAuthorization DoAuthorizationRequest is your request to authorize a customer order that can be fulfilled within 29 days. You use DoAuthorizationRequest when you are ready to ship goods to your customer. After you ship, you can capture funds with DoCapture. N O T E : DoAuthorizationRequest is for use only with order authorizations, not basic authorizations. To use DoAuthorization you must have previously created a customer order.
Authorization & Capture API DoAuthorization DoAuthorizationRequest Request to authorize all or part of a customer order amount. Fields TABLE 4.5 DoAuthorizationRequest Fields Element Description Data Type Allowable Values Required? TransactionID The value of the order’s transaction identification number returned by a PayPal product. Character length and limits: 19 single-byte characters maximum xs:string See description. Yes Amount Amount to authorize.
Authorization & Capture API DoVoid D o Vo i d DoVoidRequest voids an order or an authorization. IMPO RTANT: The AuthorizationID value on DoVoidRequest must be the original authorization identification number, not the value of AuthorizationID returned by DoReauthorizationResponse. By definition, when the authorization period expires, the authorization or reauthorization of a transaction is implicitly voided. N O T E : DoVoidRequest is for use with both basic and order authorizations.
Authorization & Capture API DoVoid DoVoidRequest Request to void a prior authorization. Fields TABLE 4.7 DoVoidRequest Fields Element Description Data Type Allowable Values Required? AuthorizationI D The value of the original authorization identification number returned by a PayPal product. xs:string See description. Yes xs:string See description.
Authorization & Capture API DoReauthorization DoReauthorization To use DoReauthorization you must have previously authorized a transaction. You can authorize a transaction in several ways: – From the Merchant Services tab of your PayPal merchant account. – With the DoExpressCheckoutPaymentRequest PaymentAction element set to Authorization. – With a shopping cart transaction (such as one that uses PayPal Website Payments) with the paymentaction HTML variable set to authorization.
Authorization & Capture API DoReauthorization DoReauthorizationRequest Request to use Authorization & Capture to reauthorize a transaction. Fields TABLE 4.9 DoReauthorizationRequest Fields Element Description Data Type Allowable Values Required? Authorization The value of a previously authorized transaction identification number returned by a PayPal product. xs:string Any previously authorized PayPal transaction identification number. Yes cc:BasicAmount Type See description.
5 Direct Payment API With the Direct Payment API, you can obtain payment through PayPal directly from a buyer’s credit card without the buyer logging into PayPal. Diagram of DoDirectPayment Types The following diagram represents the composition of the DoDirectPaymentRequestType and DoDirectPaymentResponseType elements. Elements required in the request are indicated with an asterisk. FIGURE 5.
Direct Payment API DoDirectPaymentRequest DoDirectPaymentRequest Request to use PayPal Direct Payment to obtain payment. You must include the PaymentAction element in DoDirectPaymentRequest. Allowable values for the PaymentAction element are Sale or Authorization: z z Set PaymentAction to Sale if the buyer’s order is final (for example, if the total cost of the order is complete with shipping, handling and tax charges). This transaction is your payment, and you expect no additional charge to the buyer.
Direct Payment API DoDirectPaymentRequest TABLE 5.1 DoDirectPaymentRequest Fields Element Description Data Type IPAddress IP address of the payer’s browser as recorded in its HTTP request to your website. xs:string Allowable Values Required ? Any valid Internet Protocol address. Yes N O T E : PayPal records this IP addresses as a means to detect possible fraud. Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.
Direct Payment API DoDirectPaymentRequest TABLE 5.2 CreditCardDetailsType Fields Element Description Data Type Allowable Values Required ? CVV2 Card Verification Value, version 2. xs:string See description. No. See note in description. N O T E : You must include a CVV2 value for those credit cards that use CVV2. Required for Visa, MasterCard, American Express, and Discover cards. Other card types might not require a CVV2 value.
Direct Payment API DoDirectPaymentRequest TABLE 5.3 Request: PaymentDetailsType Fields Element Description Data Type Allowable Values Required? ShippingTotal Total shipping costs for this order. ebl:BasicAmount See description. No N O T E : You must set the currencyID attribute to Type See description. No See description. No one of the three-character currency codes for any of the supported PayPal currencies. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol.
Direct Payment API DoDirectPaymentRequest TABLE 5.3 Request: PaymentDetailsType Fields Element Description Data Type Allowable Values Required? NotifyURL Your URL for receiving Instant Payment Notification (IPN) about this transaction. xs:string See description. No N O T E : If you do not specify NotifyURL in the request, the notification URL from your Merchant Profile is used, if one exists.
Direct Payment API DoDirectPaymentRequest TABLE 5.4 Request: ShipToAddress: AddressType Fields Element Descriptions Data Type Allowable Values Required ? Country Country code. Character limit: Two single-byte characters ebl:CountryCode See Appendix B. Yes Type xs:string TABLE 5.5 StateOrProvince: Abbreviations for Canada and U.S. Canadian Province or U.S.
Direct Payment API DoDirectPaymentRequest TABLE 5.5 StateOrProvince: Abbreviations for Canada and U.S. Canadian Province or U.S.
Direct Payment API DoDirectPaymentRequest TABLE 5.5 StateOrProvince: Abbreviations for Canada and U.S. Canadian Province or U.S.
Direct Payment API DoDirectPaymentRequest TABLE 5.6 Request: PaymentDetailsItemType Fields Element Description Data Type Allowable Values Required ? Name Item name. Character length and limitations: 127 single-byte characters xs:string See description. No Amount Cost of item ebl:BasicAmount See description. No N O T E : You must set the currencyID attribute to Type one of the three-character currency codes for any of the supported PayPal currencies.
Direct Payment API DoDirectPaymentRequest TABLE 5.7 CardOwner: PayerInfoType Fields Element Address Description DataType Payer’s billing address information ns:AddressType Allowable Values Required ? See Table 5.8 on page 61. Yes TABLE 5.8 CardOwner: AddressType Fields Description DataType Allowable Values Required ? Street1 First street address Character length and limitations: 100 single-byte characters xs:string See description.
Direct Payment API DoDirectPaymentResponse DoDirectPaymentResponse Response to DoDirectPaymentRequest. The Direct Payment API response contains the TransactionID element. In the case of a final Sale, TransactionID is your record of the transaction processed with PayPal. In the case of an Authorization, TransactionID is your key to capturing funds with PayPal Authorization & Capture.
Direct Payment API DoDirectPaymentResponse TABLE 5.
Direct Payment API DoDirectPaymentResponse TABLE 5.
6 Express Checkout API The Express Checkout API is the Website Payments Pro alternative to standard PayPal shopping cart processing. IMPO RTANT: For a full understanding of the complete details about how to use PayPal Express Checkout, consult the PayPal Express Checkout Integration Guide. The Express Checkout API consists of three distinct SOAP requests that you make at the three integration points during a customer checkout: 1. SetExpressCheckout 2. GetExpressCheckoutDetails 3.
Express Checkout API SetExpressCheckout SetExpressCheckout SetExpressCheckout indicates to PayPal that you are using Express Checkout to obtain payment from your customer. Diagram of Set ExpressCheckout Types The following diagram represents the composition of the SetExpressCheckoutRequestType and SetExpressCheckoutResponseType elements. Elements required in the request are indicated with an asterisk. FIGURE 6.
Express Checkout API SetExpressCheckout SetExpressCheckoutRequest Request to use PayPal Express Checkout to obtain payment. IMPO RTANT: Any fields in the WSDL or XSD files that are not described here are ignored. For example, do not set CountryName. Fields TABLE 6.1 SetExpressCheckoutRequest Fields Allowable Values Required ? ebl:Express CheckoutTokenType See the description of “Token” on page 72. No cc:BasicAmount Type See description.
Express Checkout API SetExpressCheckout TABLE 6.1 SetExpressCheckoutRequest Fields Allowable Values Required ? cc:BasicAmount Type See description. No Element Description Data Type MaxAmount The expected maximum total amount of the complete order, including shipping cost and tax charges. N O T E : You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.
Express Checkout API SetExpressCheckout TABLE 6.1 SetExpressCheckoutRequest Fields Allowable Values Required ? ebl:AddressType See Table 6.2 on page 71. No xs:string 0 1 No Element Description Data Type Address Customer’s shipping address. N O T E : If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsRes ponse.
Express Checkout API SetExpressCheckout TABLE 6.1 SetExpressCheckoutRequest Fields 70 Element Description Data Type Allowable Values Required ? PageStyle Sets the Custom Payment Page Style for payment pages associated with this button/link. PageStyle corresponds to the HTML variable page_style for customizing payment pages. The value is the same as the Page Style Name you chose when adding or editing the page style from the Profile subtab of the My Account tab of your PayPal account.
Express Checkout API SetExpressCheckout TABLE 6.1 SetExpressCheckoutRequest Fields Element Description Data Type PaymentAction How you want to obtain payment: z Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. z Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization & Capture. z Sale indicates that this is a final sale for which you are requesting payment.
Express Checkout API SetExpressCheckout TABLE 6.2 Address (Shipping Address): AddressType Elements Descriptions Data Type Allowable Values Required? Street1 First street address. Character length and limitations: 100 single-byte characters xs:string See description. Yes Street2 Second street address. Character length and limitations: 100 single-byte characters xs:string See description. No CityName Name of city.
Express Checkout API GetExpressCheckoutDetails G e t E x p r e s s C h e c k o u t D e ta i l s GetExpressCheckoutDetails returns information about the customer, including name and address on file with PayPal. Diagram of GetExpressCheckoutDetails Types The following diagram represents the composition of the GetExpressCheckoutDetailsRequestType and GetExpressCheckoutDetailsResponseType elements. Elements required in the request are indicated with an asterisk. FIGURE 6.
Express Checkout API GetExpressCheckoutDetails GetExpressCheckoutDetailsRequest Obtain details about a payment to be processed by PayPal Express Checkout. Fields TABLE 6.4 GetExpressCheckoutDetailsRequest Fields Element Description Data Type Allowable Values Required ? Token A timestamped token, the value of which was returned by SetExpressCheckoutResponse.
Express Checkout API GetExpressCheckoutDetails TABLE 6.5 GetExpressCheckoutDetailsResponse Fields Element Description Data Type Possible Values ContactPhone Payer’s contact telephone number. xs:string See description. N O T E : PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.
Express Checkout API GetExpressCheckoutDetails TABLE 6.7 Response: PayerName Elements Element Description DataType Possible Values Salutation Payer’s salutation Character length and limitations: 20 single-byte characters xs:string See description. FirstName Payer’s first name Character length and limitations: 25 single-byte characters ebl:PersonNameType See description.
Express Checkout API DoExpressCheckoutPayment TABLE 6.8 Response: AddressType Fields Element Descriptions Data Type Possible Values Street2 Second street address. Character length and limitations: 100 single-byte characters xs:string See description. CityName Name of city. Character length and limitations: 40 single-byte characters xs:string See description. StateOr Province State or province Character length and limitations: 40 single-byte characters xs:string See description.
Express Checkout API DoExpressCheckoutPayment FIGURE 6.
Express Checkout API DoExpressCheckoutPayment DoExpressCheckoutPaymentRequest Request to obtain payment with PayPal Express Checkout. IMPO RTANT: PayPal requires that a merchant using Express Checkout display to the customer the same exact amount that the merchant sends to PayPal in the OrderTotal element with the DoExpressCheckoutPaymentRequest API. Fields TABLE 6.
Express Checkout API DoExpressCheckoutPayment TABLE 6.9 DoExpressCheckoutPaymentRequest Fields Element Description Data Type PaymentDetails Information about the payment ebl:PaymentDetails Type Allowable Values Required ? See Table 6.10 on page 80. Yes TABLE 6.10 Request: PaymentDetailsType Fields Element Description Data Type Allowable Values Required ? OrderTotal Total of order, including shipping, handling, and tax. ebl:BasicAmount See description. Yes See description.
Express Checkout API DoExpressCheckoutPayment TABLE 6.10 Request: PaymentDetailsType Fields Element Description Data Type Allowable Values Required ? Handling Total Total handling costs for this order. ebl:BasicAmount See description. No N O T E : You must set the currencyID attribute to Type See description. No 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.
Express Checkout API DoExpressCheckoutPayment TABLE 6.10 Request: PaymentDetailsType Fields Allowable Values Required ? ebl:AddressType See Table 6.11 on page 82. No ebl:PaymentDetails See Table 6.12 on page 83. No Element Description Data Type ShipToAddress Address the order will be shipped to. PaymentDetails Item Details about each individual item included in the order ItemType N O T E : The AddressType elements are required only if you include the Address element in the SOAP request.
Express Checkout API DoExpressCheckoutPayment TABLE 6.12 Request: PaymentDetailsItemType Fields Element Description Data Type Allowable Values Required ? Name Item name. Character length and limitations: 127 single-byte characters xs:string See description. No Amount Cost of item ebl:BasicAmount See description. No N O T E : You must set the currencyID attribute to Type one of the three-character currency codes for any of the supported PayPal currencies.
Express Checkout API DoExpressCheckoutPayment Fields TABLE 6.13 DoExpressCheckoutPaymentResponse Fields Element Description Data Type Possible Values Token The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest. Character length and limitations:20 single-byte characters xs:string See the description of “Token” on page 72. PaymentInfo Information about the payment. ebl:PaymentInfo See Table 6.14 on page 84. Type TABLE 6.
Express Checkout API DoExpressCheckoutPayment TABLE 6.14 Response: PaymentInfoType Elements Element Description Data Type PayPal fee amount charged for the transaction ebl:BasicAmount 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 thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
Express Checkout API DoExpressCheckoutPayment TABLE 6.14 Response: PaymentInfoType Elements Element PendingReason 86 Description Data Type The reason the payment is pending: 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. To change your preference, go to the Preferences section of your Profile.
7 GetTransactionDetails API The GetTransactionDetails API retrieves information about a single transaction. Diagram of GetTransactionDetails Types The following diagram represents the composition of the GetTransactionDetailsRequestType and GetTransactionDetailsResponseType elements. FIGURE 7.
GetTransactionDetails API GetTransactionDetailsRequest G e t Tr a n s a c t i o n D e ta i l s R e q u e s t Get details about a transaction. Fields TABLE 7.1 GetTransactionDetailsRequest Fields Element Description Data Type Possible Values Required? TransactionID Unique identifier of a transaction. xs:string Transaction-specific Yes N O T E : The details for some kinds of transactions cannot be retrieved with GetTransactionDetailsRequest.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Included Element Includes elements described below ebl:ReceiverInfo Type Business Email address or account ID of the payment recipient (the seller). Equivalent to Receiver if payment is sent to primary account. Character length and limitations: 127 single-byte alphanumeric characters xs:string Receiver Primary email address of the payment recipient (the seller).
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Data Type and Possible Values Included Element Description Suffix Payer’s suffix Character length and limitations: 12 single-byte characters ebl:SuffixType PayerCountry Payment sender’s country of residence using standard two-character ISO 3166 country codes. See Appendix .
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Data Type and Possible Values Included Element Description CountryName Expanded name of country. Character length and limitations: 64 single-byte alphanumeric characters xs:string Phone Phone number associated with this address xs:string PostalCode Postal code xs:string Includes the following elements. ebl:PaymentInfo Type Original transaction to which this transaction is related.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Data Type and Possible Values Included Element Description PaymentStatus The status of the payment: None: No status Canceled-Reversal: A reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element 94 Data Type and Possible Values Included Element Description PendingReason The reason the payment is pending: 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.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Description ReasonCode The reason for a reversal if TransactionType is reversal: none: No reason code chargeback: A reversal has occurred on this transaction due to a chargeback by your customer. guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.
GetTransactionDetails API GetTransactionDetailsResponse TABLE 7.2 GetTransactionDetailsResponse Fields Element Description Options PayPal item options for shopping cart ns:OptionType name: xs:string value: xs:string Includes the following elements ebl:Subscription InfoType SubscriptionID ID generated by PayPal for the subscriber.
8 MassPay API The MassPay API is the programmatic counterpart to the Mass Payment feature available through the PayPal website. You can include up to 250 payments per MassPayRequest. You must have a PayPal balance in each currency in which you want to make a payment and have sufficient funds to cover the entire Mass Payment amount and fee. You cannot mix currencies in the same MassPayRequest; a separate request is required for each currency.
MassPay API MassPayRequest MassPayRequest Process payments en masse to up to 250 different recipients. Fields TABLE 8.1 MassPayRequestType Fields Element Description Data Type Possible Values Required? EmailSubject Subject line of the email sent to all recipients. This subject is not contained in the input file; you must create it with your application. Character length and limitations: 255 single-byte alphanumeric characters xs:string See description.
MassPay API MassPayRequest TABLE 8.3 MassPayItemType Fields Element Description Data Type Possible Values Required? ReceiverEmail Email address of recipient. I M P O R T A N T : You must specify either ReceiverEmail or ReceiverID, but you must not mix ReceiverEmail and ReceiverID in the group of MassPayItems. Use only one or the other, but not both, in a single request. Character length and limitations: 127 single-byte characters maximum. ebl:EmailAddress Type See descirption.
MassPay API MassPayResponse MassPayResponse Response to MassPayRequest. Fields The elements returned are the same as for AbstractResponseType. See page 36. For error codes and messages and their meanings, see Appendix , “Error Codes and Messages for All PayPal APIs.
9 RefundTransaction API Use the RefundTransaction API to make either full or partial refunds. Instant Payment Notification: Use of the RefundTransaction API triggers the sending of an Instant Payment Notification email to the recipient of the refund. Diagram of RefundTransaction Types The following diagram represents the composition of the RefundTransactionRequestType and RefundTransactionResponseType elements. FIGURE 9.1 RefundTransaction Types RefundTransactionRequest Request to refund a payment.
RefundTransaction API RefundTransactionResponse Fields TABLE 9.1 RefundTransactionRequest Fields Element Description Data Type Possible Values Required? TransactionID Unique identifier of a transaction Character length and limitations: 17 single-byte alphanumeric characters xs:string Transaction-specific Yes RefundType Type of refund you are making ebl:RefundPurpose TypeCodeType xs:token Other Full Partial Yes Amount Refund amount. Amount is required if RefundType is Partial.
10 TransactionSearch API With TransactionSearchRequest you must always set the StartDate field. Some other behavior: z Setting TransactionID overrides all other fields (even the required StartDate field). z The effect of setting other elements is additive or can alter the search criteria. TransactionSearchResponse returns up to 100 matches. Partial matches are displayed. For example, setting the TransactionSearchRequest FirstName to “Jess” returns results such as “Jessica” and “Jesse”.
TransactionSearch API TransactionSearchRequest Tr a n s a c t i o n S e a r c h R e q u e s t Request to search transaction history. Fields TABLE 10.1 TransactionSearchRequest Fields Element Description Data Type Allowable Values Required? StartDate The earliest transaction date at which to start the search. xs:dateTime Transaction-specific Yes N O T E : No wildcards are allowed. The value must be in UTC/GMT format.
TransactionSearch API TransactionSearchRequest TABLE 10.
TransactionSearch API TransactionSearchResponse TABLE 10.1 TransactionSearchRequest Fields Element Description Data Type Allowable Values Required? Status Search by transaction status: Pending: The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason element. For more information, see “PendingReason” on page 94. Processing: The payment is being processed.
TransactionSearch API TransactionSearchResponse TABLE 10.
TransactionSearch API TransactionSearchResponse 108 July 2006 Web Services API Reference
A Error Codes and Messages for All PayPal APIs General API Errors TABLE A.1 General API Errors Error Code Short Message Long Message Correcting This Error 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. For your security, PayPal does not report exactly which of these three values might be in error.
Error Codes and Messages for All PayPal APIs Authorization & Capture API Errors TABLE A.
Error Codes and Messages for All PayPal APIs Authorization & Capture API Errors TABLE A.2 Authorization & Capture API Error Messages Error Code Short Message Returned By API Call... 10600 Authorization voided. Authorization is voided. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10601 Authorization expired. Authorization has expired. DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. 10602 Authorization completed.
Error Codes and Messages for All PayPal APIs Authorization & Capture API Errors TABLE A.2 Authorization & Capture API Error Messages 112 Error Code Short Message Long Message Returned By API Call... 10610 Amount limit exceeded. Amount specified exceeds allowable limit. DoAuthorization DoCapture DoReauthorization Reattempt the request with a lower amount. 10611 Not enabled. Authorization & Capture feature is not enabled for the merchant. Contact customer service.
Error Codes and Messages for All PayPal APIs Authorization & Capture API Errors TABLE A.2 Authorization & Capture API Error Messages Error Code Short Message Long Message Returned By API Call... 10620 Order has already been voided, expired or completed. Order has already been voided, expired or completed. DoAuthorization DoCapture DoVoid Close this order. 10621 Order has expired. Order has expired. DoAuthorization DoCapture DoVoid Close this order. 10622 Order is voided. Order is voided.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.2 Authorization & Capture API Error Messages Error Code Short Message Returned By API Call... 10628 This transaction cannot be processed at this time. Please try again later. This transaction cannot be processed at this time. Please try again later. DoAuthorization DoCapture DoReauthorization DoVoid Retry the request at a later time. 10629 Reauthorizatio n not allowed.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors Error Code Short Message 10504 Long Message Corrective Action Invalid Data This transaction cannot be processed. Please enter a valid Credit Card Verification Number. The CVV provide is invalid. The CVV is between 3-4 digits long 10505 Gateway Decline This transaction cannot be processed.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors 116 Error Code Short Message 10527 Long Message Corrective Action Invalid Data This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is invalid 10534 Gateway Decline This transaction cannot be processed. Please enter a valid credit card number and type. The credit card entered is currently restricted by PayPal.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10546 Gateway Decline This transaction cannot be processed. The transaction was declined by PayPal because of possible fraudulent activity on the IP address. Contact PayPal for more information 10547 Internal Error This transaction cannot be processed.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors 118 Error Code Short Message 10703 Long Message Corrective Action Invalid Data There's an error with this transaction. Please enter a valid address2 in the billing address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid 10704 Invalid Data There's an error with this transaction.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors Error Code Short Message 10713 Long Message Corrective Action 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 will tell you what field is invalid 10713 Invalid Data There's an error with this transaction. Please enter a country in the billing address.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors 120 Error Code Short Message 10724 Long Message Corrective Action Invalid Data There's an error with this transaction. Please enter your five digit postal code in the shipping address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid 10725 Invalid Data There's an error with this transaction.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors Error Code Short Message 10732 Long Message Corrective Action Invalid Data There's an error with this transaction. Please enter a valid shipping address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid 10733 Invalid Data There's an error with this transaction. Please enter a valid state in the shipping address.
Error Codes and Messages for All PayPal APIs Direct Payments API Errors TABLE A.3 Direct Payment API Errors 122 Error Code Short Message 10751 Long Message Corrective Action Invalid Data There's an error with this transaction. Please enter a valid state in the billing address. The merchant provided an address either in the United States or Canada, but the state provided is not a valid state in either country 10752 Gateway Decline This transaction cannot be processed.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.3 Direct Payment API Errors Error Code Short Message Long Message Corrective Action 15002 Gateway Decline This transaction cannot be processed. The transaction was declined by PayPal. Contact PayPal for more information 15003 Invalid Configuration This transaction cannot be processed. The transaction was declined because the merchant does not have a valid commercial entity agreement on file with PayPal.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.4 SetExpressCheckout API Errors 124 Error Code Short Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.4 SetExpressCheckout API Errors Error Code Short Message 10407 Transaction refused because of an invalid argument. See additional error messages for details. Invalid buyer email address (BuyerEmail). 10409 You're not authorized to access this info. Express Checkout token was issued for a merchant account other than yours. 10410 Invalid token Invalid token. 10411 This Express Checkout session has expired.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.4 SetExpressCheckout API Errors 126 Error Code Short Message 10415 Long Message Correcting This Error... 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.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.4 SetExpressCheckout API Errors Error Code Short Message 10436 Transaction refused because of an invalid argument. See additional error messages for details. PageStyle value exceeds maximum allowable length. 10437 Transaction refused because of an invalid argument. See additional error messages for details. cpp-header-image value exceeds maximum allowable length.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.4 SetExpressCheckout API Errors 128 Error Code Short Message 10537 Risk Control Country Filter Failure The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings. 10538 Risk Control Max Amount Failure The transaction was refused because the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.5 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 10004 Transaction refused because of an invalid argument.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.5 GetExpressCheckoutDetails API Errors Error Code Short Message 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors Error Code Short Message 10001 ButtonSource value truncated. The transaction could not be loaded 10001 Internal Error Internal Error 10004 Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors Error Code Short Message 10411 This Express Checkout session has expired. This Express Checkout session has expired. Token value is no longer valid. 10412 Duplicate invoice Payment has already been made for this InvoiceID. 10413 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors Error Code Short Message 10417 Transaction cannot complete. Long Message Correcting This Error... The transaction cannot complete successfully. Instruct the customer to use an alternative payment method. It is possible that the payment method the customer chooses on PayPal might not succeed when you send DoExpressCheckoutPayment.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors Error Code Short Message 10421 This Express Checkout session belongs to a different customer. Long Message Correcting This Error... This Express Checkout session belongs to a different customer. Token value mismatch. When your customer logs into PayPal, the PayPal PayerID is associated with the Express Checkout token. This error is caused by mixing tokens for two different PayerIDs.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors Error Code Short 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 OrderDescription element has been truncated.
Error Codes and Messages for All PayPal APIs Express Checkout API Errors TABLE A.6 DoExpressCheckoutPayment API Errors 136 Error Code Short Message 10443 Transaction refused because of an invalid argument. See additional error messages for details. This transaction cannot be completed with PaymentAction of Order. 10444 Transaction refused because of an invalid argument. See additional error messages for details. The transaction currency specified must be the same as previously specified.
Error Codes and Messages for All PayPal APIs GetTransactionDetails API Errors TABLE A.
Error Codes and Messages for All PayPal APIs MassPay API Errors MassPay API Errors TABLE A.8 MassPay API Errors 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.
Error Codes and Messages for All PayPal APIs MassPay API Errors TABLE A.8 MassPay API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The number of input records is less than or equal to zero 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs MassPay API Errors TABLE A.8 MassPay API Errors Error Code 140 Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. Currency is not supported 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.
Error Codes and Messages for All PayPal APIs MassPay API Errors TABLE A.8 MassPay API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The unique id string contains a space as a character 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs MassPay API Errors TABLE A.
Error Codes and Messages for All PayPal APIs RefundTransaction API Errors RefundTransaction API Errors TABLE A.9 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 ButtonSource value truncated. The transaction could not be loaded 10001 Internal Error Internal Error 10004 Transaction refused because of an invalid argument.
Error Codes and Messages for All PayPal APIs RefundTransaction API Errors TABLE A.9 RefundTransaction API Errors 144 Error Code Short Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. The partial refund amount must be a positive amount 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs RefundTransaction API Errors TABLE A.
Error Codes and Messages for All PayPal APIs TransactionSearch API Errors TABLE A.
Error Codes and Messages for All PayPal APIs TransactionSearch API Errors TABLE A.10 TransactionSearch API Errors Error Code Short Message Long Message 10004 Transaction refused because of an invalid argument. See additional error messages for details. End date is invalid 10004 Transaction refused because of an invalid argument. See additional error messages for details. Currency is not supported 10004 Transaction refused because of an invalid argument. See additional error messages for details.
Error Codes and Messages for All PayPal APIs TransactionSearch API Errors TABLE A.10 TransactionSearch API Errors 148 Error Code Short Message Long Message 10007 Permission denied You do not have permissions to search for this transaction 10007 Permission denied You do not have permissions to make this API call 11002 Search warning The number of results were truncated. Please change your search parameters if you wish to see all your results.
B Country Codes Country Code Country Code BERMUDA BM AFGHANISTAN AF BHUTAN BT ÅLAND ISLANDS AX BOLIVIA BO ALBANIA AL BOSNIA AND HERZEGOVINA BA ALGERIA DZ AMERICAN SAMOA AS BOTSWANA BW ANDORRA AD BOUVET ISLAND BV BRAZIL BR ANGOLA AO ANGUILLA AI BRITISH INDIAN OCEAN TERRITORY IO ANTARCTICA AQ BRUNEI DARUSSALAM BN ANTIGUA AND BARBUDA AG BULGARIA BG ARGENTINA AR BURKINA FASO BF ARMENIA AM BURUNDI BI ARUBA AW CAMBODIA KH AUSTRALIA AU CAMEROON CM AUSTR
Country Codes 150 Country Code Country Code COMOROS KM TF CONGO CG FRENCH SOUTHERN TERRITORIES CONGO, THE DEMOCRATIC REPUBLIC OF THE CD GABON GA GAMBIA GM COOK ISLANDS CK GEORGIA GE COSTA RICA CR GERMANY DE COTE D'IVOIRE CI GHANA GH CROATIA HR GIBRALTAR GI CUBA CU GREECE GR CYPRUS CY GREENLAND GL CZECH REPUBLIC CZ GRENADA GD DENMARK DK GUADELOUPE GP DJIBOUTI DJ GUAM GU DOMINICA DM GUATEMALA GT DOMINICAN REPUBLIC DO GUERNSEY GG ECUADOR EC GUINEA
Country Codes Country Code Country Code IRAQ IQ MADAGASCAR MG IRELAND IE MALAWI MW ISLE OF MAN IM MALAYSIA MY ISRAEL IL MALDIVES MV ITALY IT MALI ML JAMAICA JM MALTA MT JAPAN JP MARSHALL ISLANDS MH JERSEY JE MARTINIQUE MQ JORDAN JO MAURITANIA MR KAZAKHSTAN KZ MAURITIUS MU KENYA KE MAYOTTE YT KIRIBATI KI MEXICO MX KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KP MICRONESIA, FEDERATED STATES OF FM KOREA, REPUBLIC OF KR MOLDOVA, REPUBLIC OF MD KUWAIT KW M
Country Codes 152 Country Code Country Code NIGERIA NG VC NIUE NU SAINT VINCENT AND THE GRENADINES NORFOLK ISLAND NF SAMOA WS NORTHERN MARIANA ISLANDS MP SAN MARINO SM SAO TOME AND PRINCIPE ST NORWAY NO SAUDI ARABIA SA OMAN OM SENEGAL SN PAKISTAN PK SERBIA AND MONTENEGRO CS PALAU PW SEYCHELLES SC PALESTINIAN TERRITORY, OCCUPIED PS SIERRA LEONE SL SINGAPORE SG PANAMA PA SLOVAKIA SK PAPUA NEW GUINEA PG SLOVENIA SI PARAGUAY PY SOLOMON ISLANDS SB PERU PE
Country Codes Country Code Country Code TANZANIA, UNITED REPUBLIC OF TZ YEMEN YE ZAMBIA ZM THAILAND TH ZIMBABWE ZW TIMOR-LESTE TL TOGO TG TOKELAU TK TONGA TO TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS, BR
Country Codes 154
Index Symbols .NET SDK Guide 18 A AbstractRequestType 35, 36 AbstractResponseType 35, 36, 100 Ack 28, 37 success response 29 Address 61, 69, 90 Address Verification System 62 AddressOverride 69 AddressOwner 90 AddressOwnerTypeCode 90 AddressStatus 90 AddressStatus CodeType 90 AddressType 56, 69, 82, 90 AddressVerifyResponseType 40, 45, 47, 49, 51, 66, 73, 77 All 105 Amount 60, 83, 95, 96, 99, 102, 105 API Certificate 23 API password 24 API Signature 23 API username 24 api.paypal.com 32, 33 api-3t.paypal.
Index currencyID 54, 55, 60, 67, 68, 80, 81, 83, 99, 105 currencyId must be GBP if CreditCardType is switch or Solo 53 currencyID required attribute 32 Custom 55, 68, 74, 81, 95 CustomCode 37 CVV2 54 CVV2Code 62 FailureWithWarning 37 Fee 105 FeeAmount 42, 85, 92, 107 FeeRefundAmount 102 FirstName 60, 76, 89, 105 First-Party Access 23 FundsAdded 105 FundsWithdrawn 105 D G date/time values 31 dateTime data type 31 Denied 43, 93 Denied (transaction status) 106 Direct Payment 32 Dividend 105 DoAuthorizatio
Index M MassPay 33, 105 MassPayItem 98 MassPayItemType 98 MassPayRequest 97 MassPayRequestItemType 97 MassPayRequestType 97 MassPayResponseType 97 MaxAmount 68 Memo 102 MerchantSessionId 53 MiddleName 76, 89, 105 MoneyRequest 105 multiItem 96 N Name 83, 90, 95 NameType 76, 89 NetAmount 107 NetRefund 102 NoShipping 69 Note 99 NotifyURL 81 Number 60, 83, 95 numeric data types 31 O Options 96 OptionType 96 Order Management Integration Guide 18 OrderDescription 55, 68, 81 OrderTotal 54, 67, 80 P ParentTrans
Index R ReasonCode 43, 93, 95 ReasonCodeType 95 reattempt 96 ReceiptID 91, 104 Received 105 Receiver 89, 104 ReceiverEmail 99 ReceiverID 89 ReceiverInfo 88, 89 ReceiverInfo Type 89 Recurrences 96 recurring 96 Referral 105 Refund (transaction class) 105 Refunded 43, 93 RefundPurposeTypeCodeType 102 RefundTransaction 33 RefundTransactionID 102 RefundTransactionRequest 101, 102 RefundTransactionRequestType 101 RefundTransactionResponseType 101 RefundType 101, 102 ReqConfirmShipping 69 RequesterCredentials 24,
Index U Unicode 31 UniqueID 99 UserID 98 UserIDType 75, 89 Username 23, 24, 27, 96 UTC/GMT 29, 31, 36, 106 V Version 27, 36, 37 Virtual Terminal User Guide 18 Voided 43, 93 W Web Services 19, 21 Web Services API Reference 18 Website Payments Pro Integration Guide 17 Website Payments Standard Integration Guide 17 WSDL 21, 22 location of PayPal WSDL configuration file 22 X XSD 21 location for PayPal Web Services 22 Web Services API Reference July 2006 159
