PayPal Web Services API - 2006 User Manual

Last Updated: July 2006For Professional Use OnlyCurrently only available in English.A usage Professional UniquementDisponible en Anglais uniquement po

List of Tables10 July 2006 Web Services API Reference

MassPay APIMassPayResponse100 July 2006 Web Services API ReferenceMassPayResponseResponse to MassPayRequest.FieldsThe elements returned are the same a

Web Services API Reference July 2006 1019RefundTransaction APIUse the RefundTransaction API to make either full or partial refunds.Instant Payment Not

RefundTransaction APIRefundTransactionResponse102 July 2006 Web Services API ReferenceFieldsRefundTransactionResponseResponse to RefundTransactionRequ

Web Services API Reference July 2006 10310TransactionSearch APIWith TransactionSearchRequest you must always set the StartDate field. Some other behav

TransactionSearch APITransactionSearchRequest104 July 2006 Web Services API ReferenceTransactionSearchRequestRequest to search transaction history.Fie

Web Services API Reference July 2006 105TransactionSearch APITransactionSearchRequestPayerNameSearch by the buyer's nameSalutation: 20 single-byt

TransactionSearch APITransactionSearchResponse106 July 2006 Web Services API ReferenceTransactionSearchResponseResponse to TransactionSearchRequest.Fi

Web Services API Reference July 2006 107TransactionSearch APITransactionSearchResponseGrossAmountThe total gross amount charged, including any profile

TransactionSearch APITransactionSearchResponse108 July 2006 Web Services API Reference

July 2006 109AError Codes and Messages for All PayPal APIsGeneral API ErrorsTABLE A.1 General API ErrorsError CodeShort Message Long Message Correctin

Web Services API Reference July 2006 11List of FiguresFigure 2.1 PayPal Web Services High-level Diagram . . . . . . . . . . . 21Figure 2.

Error Codes and Messages for All PayPal APIsAuthorization & Capture API Errors110 July 2006Authorization & Capture API Errors10002 Restricted

July 2006 111Error Codes and Messages for All PayPal APIsAuthorization & Capture API Errors10600 Authorization voided. Authorization is voided. Do

Error Codes and Messages for All PayPal APIsAuthorization & Capture API Errors112 July 200610610 Amount limit exceeded. Amount specified exceeds a

July 2006 113Error Codes and Messages for All PayPal APIsAuthorization & Capture API Errors10620 Order has already been voided, expired or complet

Error Codes and Messages for All PayPal APIsDirect Payments API Errors114 July 2006Direct Payments API Errors10628 This transaction cannot be processe

July 2006 115Error Codes and Messages for All PayPal APIsDirect Payments API Errors10504 Invalid Data This transaction cannot be processed. Please ent

Error Codes and Messages for All PayPal APIsDirect Payments API Errors116 July 200610527 Invalid Data This transaction cannot be processed. Please ent

July 2006 117Error Codes and Messages for All PayPal APIsDirect Payments API Errors10546 Gateway DeclineThis transaction cannot be processed.The trans

Error Codes and Messages for All PayPal APIsDirect Payments API Errors118 July 200610703 Invalid Data There's an error with this transaction. Ple

July 2006 119Error Codes and Messages for All PayPal APIsDirect Payments API Errors10713 Invalid Data There's an error with this transaction. Ple

List of Figures12 July 2006 Web Services API Reference

Error Codes and Messages for All PayPal APIsDirect Payments API Errors120 July 200610724 Invalid Data There's an error with this transaction. Ple

July 2006 121Error Codes and Messages for All PayPal APIsDirect Payments API Errors10732 Invalid Data There's an error with this transaction. Ple

Error Codes and Messages for All PayPal APIsDirect Payments API Errors122 July 200610751 Invalid Data There's an error with this transaction. Ple

July 2006 123Error Codes and Messages for All PayPal APIsExpress Checkout API ErrorsExpress Checkout API Errors15002 Gateway DeclineThis transaction c

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors124 July 200610004 Transaction refused because of an invalid argument. See addi

July 2006 125Error Codes and Messages for All PayPal APIsExpress Checkout API Errors10407 Transaction refused because of an invalid argument. See addi

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors126 July 200610415 Transaction refused because of an invalid argument. See addi

July 2006 127Error Codes and Messages for All PayPal APIsExpress Checkout API Errors10436 Transaction refused because of an invalid argument. See addi

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors128 July 200610537 Risk Control Country Filter Failure The transaction was refu

July 2006 129Error Codes and Messages for All PayPal APIsExpress Checkout API ErrorsTABLE A.5 GetExpressCheckoutDetails API ErrorsError CodeShort Mess

Web Services API Reference July 2006 13PrefaceThis DocumentThis document, PayPal Web Services API Reference, which describes the PayPal Web Services A

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors130 July 200610004 Transaction refused because of an invalid argument. See addi

July 2006 131Error Codes and Messages for All PayPal APIsExpress Checkout API Errors10001 ButtonSource value truncated. The transaction could not be l

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors132 July 200610411 This Express Checkout session has expired. This Express Chec

July 2006 133Error Codes and Messages for All PayPal APIsExpress Checkout API Errors10417 Transaction cannot complete. The transaction cannot complete

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors134 July 200610421 This Express Checkout session belongs to a different custome

July 2006 135Error Codes and Messages for All PayPal APIsExpress Checkout API Errors10432 Transaction refused because of an invalid argument. See addi

Error Codes and Messages for All PayPal APIsExpress Checkout API Errors136 July 200610443 Transaction refused because of an invalid argument. See addi

July 2006 137Error Codes and Messages for All PayPal APIsGetTransactionDetails API ErrorsGetTransactionDetails API Errors10725 Shipping Address Countr

Error Codes and Messages for All PayPal APIsMassPay API Errors138 July 2006MassPay API ErrorsTABLE A.8 MassPay API ErrorsError CodeShort Message Long

July 2006 139Error Codes and Messages for All PayPal APIsMassPay API Errors10004 Transaction refused because of an invalid argument. See additional er

PrefaceDocumentation Problems14 July 2006 Web Services API ReferenceTo convey additional information, this document may also apply color and underlini

Error Codes and Messages for All PayPal APIsMassPay API Errors140 July 200610004 Transaction refused because of an invalid argument. See additional er

July 2006 141Error Codes and Messages for All PayPal APIsMassPay API Errors10004 Transaction refused because of an invalid argument. See additional er

Error Codes and Messages for All PayPal APIsMassPay API Errors142 July 200610309 Masspay server unavailable The mass pay server is unavailable10310 Un

July 2006 143Error Codes and Messages for All PayPal APIsRefundTransaction API ErrorsRefundTransaction API ErrorsTABLE A.9 RefundTransaction API Error

Error Codes and Messages for All PayPal APIsRefundTransaction API Errors144 July 200610004 Transaction refused because of an invalid argument. See add

July 2006 145Error Codes and Messages for All PayPal APIsRefundTransaction API Errors10007 Permission denied You do not have permissions to make this

Error Codes and Messages for All PayPal APIsTransactionSearch API Errors146 July 2006TransactionSearch API Errors10009 Transaction refused You can not

July 2006 147Error Codes and Messages for All PayPal APIsTransactionSearch API Errors10004 Transaction refused because of an invalid argument. See add

Error Codes and Messages for All PayPal APIsTransactionSearch API Errors148 July 200610007 Permission denied You do not have permissions to search fo

149BCountry CodesCountry CodeAFGHANISTAN AFÅLAND ISLANDS AXALBANIA ALALGERIA DZAMERICAN SAMOA ASANDORRA ADANGOLA AOANGUILLA AIANTARCTICA AQANTIGUA AND

Web Services API Reference July 2006 15PrefaceRevision HistoryLog in to your account at https://developer.paypal.com/ by entering your email address a

Country Codes150COMOROS KMCONGO CGCONGO, THE DEMOCRATIC REPUBLIC OF THECDCOOK ISLANDS CKCOSTA RICA CRCOTE D'IVOIRE CICROATIA HRCUBA CUCYPRUS CYCZ

151Country CodesIRAQ IQIRELAND IEISLE OF MAN IMISRAEL ILITALY ITJAMAICA JMJAPAN JPJERSEY JEJORDAN JOKAZAKHSTAN KZKENYA KEKIRIBATI KIKOREA, DEMOCRATIC

Country Codes152NIGERIA NGNIUE NUNORFOLK ISLAND NFNORTHERN MARIANA ISLANDSMPNORWAY NOOMAN OMPAKISTAN PKPALAU PWPALESTINIAN TERRITORY, OCCUPIEDPSPANAMA

153Country CodesTANZANIA, UNITED REPUBLIC OFTZTHAILAND THTIMOR-LESTE TLTOGO TGTOKELAU TKTONGA TOTRINIDAD AND TOBAGO TTTUNISIA TNTURKEY TRTURKMENISTAN

Country Codes154

Web Services API Reference July 2006 155IndexSymbols.NET SDK Guide 18AAbstractRequestType 35, 36AbstractResponseType 35, 36, 100Ack 28, 37success resp

Index156 July 2006 Web Services API ReferencecurrencyID 54, 55, 60, 67, 68, 80, 81, 83, 99, 105currencyIdmust be GBP if CreditCardType is switch or So

Web Services API Reference July 2006 157IndexMMassPay 33, 105MassPayItem 98MassPayItemType 98MassPayRequest 97MassPayRequestItemType 97MassPayRequestT

Index158 July 2006 Web Services API ReferenceRReasonCode 43, 93, 95ReasonCodeType 95reattempt 96ReceiptID 91, 104Received 105Receiver 89, 104ReceiverE

Web Services API Reference July 2006 159IndexUUnicode 31UniqueID 99UserID 98UserIDType 75, 89Username 23, 24, 27, 96UTC/GMT 29, 31, 36, 106VVersion 27

PrefaceRevision History16 July 2006 Web Services API Reference

Web Services API Reference July 2006 171Overview of the PayPal Web Services APIThe PayPal Web Services API provides programmatic access to PayPal feat

Overview of the PayPal Web Services APIOpen Standards Background Information18 July 2006 Web Services API ReferenceOpen Standards Background Informati

Web Services API Reference July 2006 19Overview of the PayPal Web Services APIWeb Services StandardsWeb Services StandardsWeb Services are an ongoing

© 2006 PayPal Inc. All rights reserved. PayPal and the PayPal logo are registered trademarks of PayPal Inc. Other trademarks and brands are the proper

Overview of the PayPal Web Services APICryptography20 July 2006 Web Services API Reference

Web Services API Reference July 2006 212PayPal Web Services API ArchitectureThe PayPal Web Services API provides programmatic access to PayPal feature

PayPal Web Services API ArchitectureServices Architecture22 July 2006 Web Services API Referencebusiness-object interfaces and network stubs from PayP

Web Services API Reference July 2006 23PayPal Web Services API ArchitectureServices ArchitectureSecurityThe PayPal Web Services API service is protect

PayPal Web Services API ArchitectureServices Architecture24 July 2006 Web Services API ReferenceSOAP RequesterCredentials: Username, Password, Signatu

Web Services API Reference July 2006 25PayPal Web Services API ArchitectureSOAP Service EndpointsPublic/Private Key EncryptionYour security with the P

PayPal Web Services API ArchitectureSOAP Implementation26 July 2006 Web Services API ReferenceSOAP ImplementationThis section contains information abo

Web Services API Reference July 2006 27PayPal Web Services API ArchitectureSOAP ImplementationEXAMPLE 2.1 General Structure of PayPal API SOAP Request

PayPal Web Services API ArchitectureSOAP Implementation28 July 2006 Web Services API ReferenceResponse StructureThe following is an annotated descript

Web Services API Reference July 2006 29PayPal Web Services API ArchitectureSOAP ImplementationError ResponsesIf a request is malformed or some other e

Web Services API Reference July 2006 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PayPal Web Services API ArchitecturePayPal Web Services API Definitions30 July 2006 Web Services API Reference<GetTransactionDetailsResponse xmlns=

Web Services API Reference July 2006 31PayPal Web Services API ArchitecturePayPal Web Services API Definitionsz Backward compatibility: The PayPal API

PayPal Web Services API ArchitecturePayPal Web Services API Definitions32 July 2006 Web Services API ReferenceThe core currency amount data type is de

Web Services API Reference July 2006 33PayPal Web Services API ArchitecturePayPal Web Services API DefinitionsAPIs to Exchange Funds or Display Inform

PayPal Web Services API ArchitecturePayPal Web Services API Definitions34 July 2006 Web Services API Reference

Web Services API Reference July 2006 353Core eBL Request/Response StructuresThe PayPal Web Services API is built on core structures from the eBL schem

Core eBL Request/Response StructuresAbstractRequestType36 July 2006 Web Services API ReferenceAbstractRequestTypeAbstractRequestType is the base type

Web Services API Reference July 2006 37Core eBL Request/Response StructuresAbstractResponseTypeAckA token representing the application-level acknowled

Core eBL Request/Response StructuresAbstractResponseType38 July 2006 Web Services API Reference

Web Services API Reference July 2006 394Authorization & Capture APIThe Authorization & Capture API consists of individual requests and respons

Contents4 July 2006 Web Services API ReferencePayPal Web Services API Definitions . . . . . . . . . . . . . . . . . . . . . . .

Authorization & Capture APIDoCapture40 July 2006 Web Services API ReferenceDoCaptureDoCaptureRequest is your request to completely or partially se

Web Services API Reference July 2006 41Authorization & Capture APIDoCaptureDoCaptureRequestRequest to capture funds from a PayPal member’s account

Authorization & Capture APIDoCapture42 July 2006 Web Services API ReferenceDoCaptureResponseResponse to DoCaptureRequest.FieldsTABLE 4.3 DoCapture

Web Services API Reference July 2006 43Authorization & Capture APIDoCaptureTaxAmount Tax charged on the transactionebl:BasicAmountTypexs:stringTra

Authorization & Capture APIDoCapture44 July 2006 Web Services API ReferencePendingReason N OTE: PendingReason is returned in the response only if

Web Services API Reference July 2006 45Authorization & Capture APIDoAuthorizationDoAuthorizationDoAuthorizationRequest is your request to authoriz

Authorization & Capture APIDoAuthorization46 July 2006 Web Services API ReferenceDoAuthorizationRequestRequest to authorize all or part of a custo

Web Services API Reference July 2006 47Authorization & Capture APIDoVoidDoVoidDoVoidRequest voids an order or an authorization.IMPORTANT:The Autho

Authorization & Capture APIDoVoid48 July 2006 Web Services API ReferenceDoVoidRequestRequest to void a prior authorization.FieldsDoVoidResponseRes

Web Services API Reference July 2006 49Authorization & Capture APIDoReauthorizationDoReauthorizationTo use DoReauthorization you must have previou

Web Services API Reference July 2006 5ContentsFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Authorization & Capture APIDoReauthorization50 July 2006 Web Services API ReferenceDoReauthorizationRequestRequest to use Authorization & Capt

Web Services API Reference July 2006 515Direct Payment APIWith the Direct Payment API, you can obtain payment through PayPal directly from a buyer’s c

Direct Payment APIDoDirectPaymentRequest52 July 2006 Web Services API ReferenceDoDirectPaymentRequestRequest to use PayPal Direct Payment to obtain pa

Web Services API Reference July 2006 53Direct Payment APIDoDirectPaymentRequestIPAddress IP address of the payer’s browser as recorded in its HTTP req

Direct Payment APIDoDirectPaymentRequest54 July 2006 Web Services API ReferenceCVV2 Card Verification Value, version 2.NOTE: You must include a CVV2 v

Web Services API Reference July 2006 55Direct Payment APIDoDirectPaymentRequestShippingTotalTotal shipping costs for this order.NOTE: You must set the

Direct Payment APIDoDirectPaymentRequest56 July 2006 Web Services API ReferenceIMPORTANT: Any fields in the WSDL or XSD files that are not described h

Web Services API Reference July 2006 57Direct Payment APIDoDirectPaymentRequestCountryCountry code. Character limit: Two single-byte charactersebl:Cou

Direct Payment APIDoDirectPaymentRequest58 July 2006 Web Services API ReferenceDistrict Of Columbia DCFederated States Of Micronesia FMFlorida FLGeorg

Web Services API Reference July 2006 59Direct Payment APIDoDirectPaymentRequestNorth Carolina NCNorth Dakota NDNorthern Mariana Islands MPOhio OH Okla

Contents6 July 2006 Web Services API ReferenceRefundTransactionResponse . . . . . . . . . . . . . . . . . . . . . . . . . .

Direct Payment APIDoDirectPaymentRequest60 July 2006 Web Services API ReferenceTABLE 5.6 Request: PaymentDetailsItemType FieldsElement Description Dat

Web Services API Reference July 2006 61Direct Payment APIDoDirectPaymentRequestAddress Payer’s billing address informationns:AddressTypeSee Table 5.8

Direct Payment APIDoDirectPaymentResponse62 July 2006 Web Services API ReferenceDoDirectPaymentResponseResponse to DoDirectPaymentRequest.The Direct P

Web Services API Reference July 2006 63Direct Payment APIDoDirectPaymentResponseTABLE 5.10 AVS Response CodesAVS Code Meaning Matched DetailsA Address

Direct Payment APIDoDirectPaymentResponse64 July 2006 Web Services API ReferenceP Not Processed Not applicableS Service not Supported Not applicableU

Web Services API Reference July 2006 656Express Checkout APIThe Express Checkout API is the Website Payments Pro alternative to standard PayPal shoppi

Express Checkout APISetExpressCheckout66 July 2006 Web Services API ReferenceSetExpressCheckoutSetExpressCheckout indicates to PayPal that you are usi

Web Services API Reference July 2006 67Express Checkout APISetExpressCheckoutSetExpressCheckoutRequestRequest to use PayPal Express Checkout to obtain

Express Checkout APISetExpressCheckout68 July 2006 Web Services API ReferenceMaxAmountThe expected maximum total amount of the complete order, includi

Web Services API Reference July 2006 69Express Checkout APISetExpressCheckoutAddressCustomer’s shipping address.NOTE: If you include a shipping addres

Web Services API Reference July 2006 7List of TablesTable 1.1 Revision History . . . . . . . . . . . . . . . . . . . . . . .

Express Checkout APISetExpressCheckout70 July 2006 Web Services API ReferencePageStyleSets the Custom Payment Page Style for payment pages associated

Web Services API Reference July 2006 71Express Checkout APISetExpressCheckoutNOTE: The AddressType elements are required only if you include the Addre

Express Checkout APISetExpressCheckout72 July 2006 Web Services API ReferenceSetExpressCheckoutResponseResponse to SetExpressCheckoutRequest.FieldsStr

Web Services API Reference July 2006 73Express Checkout APIGetExpressCheckoutDetailsGetExpressCheckoutDetailsGetExpressCheckoutDetails returns informa

Express Checkout APIGetExpressCheckoutDetails74 July 2006 Web Services API ReferenceGetExpressCheckoutDetailsRequestObtain details about a payment to

Web Services API Reference July 2006 75Express Checkout APIGetExpressCheckoutDetailsNOTE: Empty elements are returned if there is no representative da

Express Checkout APIGetExpressCheckoutDetails76 July 2006 Web Services API ReferenceTABLE 6.7 Response: PayerName ElementsElement Description DataType

Web Services API Reference July 2006 77Express Checkout APIDoExpressCheckoutPaymentDoExpressCheckoutPaymentWith DoExpressCheckoutPayment, you either o

Express Checkout APIDoExpressCheckoutPayment78 July 2006 Web Services API ReferenceFIGURE 6.3 DoExpressCheckoutPayment Types

Web Services API Reference July 2006 79Express Checkout APIDoExpressCheckoutPaymentDoExpressCheckoutPaymentRequestRequest to obtain payment with PayPa

List of Tables8 July 2006 Web Services API ReferenceTable 5.9 DoDirectPaymentResponse Fields . . . . . . . . . . . . . . . . . . .

Express Checkout APIDoExpressCheckoutPayment80 July 2006 Web Services API ReferencePaymentDetailsInformation about the payment ebl:PaymentDetailsTypeS

Web Services API Reference July 2006 81Express Checkout APIDoExpressCheckoutPaymentHandlingTotalTotal handling costs for this order.NOTE: You must set

Express Checkout APIDoExpressCheckoutPayment82 July 2006 Web Services API ReferenceNOTE: The AddressType elements are required only if you include the

Web Services API Reference July 2006 83Express Checkout APIDoExpressCheckoutPaymentDoExpressCheckoutPaymentResponseResponse to DoExpressCheckoutPaymen

Express Checkout APIDoExpressCheckoutPayment84 July 2006 Web Services API ReferenceFieldsTABLE 6.13 DoExpressCheckoutPaymentResponse FieldsElement Des

Web Services API Reference July 2006 85Express Checkout APIDoExpressCheckoutPaymentFeeAmount PayPal fee amount charged for the transactionCharacter le

Express Checkout APIDoExpressCheckoutPayment86 July 2006 Web Services API ReferencePendingReason The reason the payment is pending:none: No pending re

Web Services API Reference July 2006 877GetTransactionDetails APIThe GetTransactionDetails API retrieves information about a single transaction.Diagra

GetTransactionDetails APIGetTransactionDetailsRequest88 July 2006 Web Services API ReferenceGetTransactionDetailsRequestGet details about a transactio

Web Services API Reference July 2006 89GetTransactionDetails APIGetTransactionDetailsResponseReceiverInfoIncludes elements described below ebl:Receive

Web Services API Reference July 2006 9List of Tables

GetTransactionDetails APIGetTransactionDetailsResponse90 July 2006 Web Services API ReferenceSuffixPayer’s suffixCharacter length and limitations: 12

Web Services API Reference July 2006 91GetTransactionDetails APIGetTransactionDetailsResponseCountryNameExpanded name of country.Character length and

GetTransactionDetails APIGetTransactionDetailsResponse92 July 2006 Web Services API ReferencePaymentTypeThe type of paymentebl:PaymentCodeTypexs:strin

Web Services API Reference July 2006 93GetTransactionDetails APIGetTransactionDetailsResponsePaymentStatusThe status of the payment:None: No statusCan

GetTransactionDetails APIGetTransactionDetailsResponse94 July 2006 Web Services API ReferencePendingReasonThe reason the payment is pending:none: No p

Web Services API Reference July 2006 95GetTransactionDetails APIGetTransactionDetailsResponseReasonCodeThe reason for a reversal if TransactionType is

GetTransactionDetails APIGetTransactionDetailsResponse96 July 2006 Web Services API ReferenceOptionsPayPal item options for shopping cartns:OptionType

Web Services API Reference July 2006 978MassPay APIThe MassPay API is the programmatic counterpart to the Mass Payment feature available through the P

MassPay APIMassPayRequest98 July 2006 Web Services API ReferenceMassPayRequestProcess payments en masse to up to 250 different recipients.FieldsTABLE

Web Services API Reference July 2006 99MassPay APIMassPayRequestTABLE 8.3 MassPayItemType FieldsElement Description Data Type Possible Values Required