PayPal Name-Value Pair API - 2007 Manual do Utilizador

Name-Value Pair API Reference for GermanyFor Professional Use in Germany OnlyCurrently only available in English.A usage Professional en Allemagne uni

OverviewBasic Steps10 April 2007 Name-Value Pair API Developer Guide and ReferenceFor details about the PayPal NVP SDK, see Appendix D, “The Java SDK”

NVP API Web SamplesSamples Using Classic ASP100 April 2007 Name-Value Pair API Developer Guide and ReferenceSamples Using Classic ASPThis section cont

Name-Value Pair API Developer Guide and Reference April 2007 101NVP API Web SamplesSamples Using ColdFusionSamples Using ColdFusionThis section contai

NVP API Web SamplesSamples Using ColdFusion102 April 2007 Name-Value Pair API Developer Guide and Reference

D Name-Value Pair API Developer Guide and Reference April 2007 103The Java SDKThis section describes how to use the Java SDK for the NVP API and incl

The Java SDKInstalling the Java SDK104 April 2007 Name-Value Pair API Developer Guide and ReferenceRecommended Hardware ConfigurationThe minimum hardw

Name-Value Pair API Developer Guide and Reference April 2007 105The Java SDKComplete SDK and API Class DocumentationComplete SDK and API Class Documen

The Java SDKProfiles106 April 2007 Name-Value Pair API Developer Guide and ReferenceProfilesBefore the SDK can be used, it must know the profile of th

Name-Value Pair API Developer Guide and Reference April 2007 107The Java SDKSample ApplicationsSample ApplicationsThe PayPal SDK includes sample appli

The Java SDKSample Applications108 April 2007 Name-Value Pair API Developer Guide and ReferenceSample API User with API SignatureThe samples come with

E Name-Value Pair API Developer Guide and Reference April 2007 109The ASP.NET SDKThis section describes how to use the ASP.NET SDK for the NVP API an

Name-Value Pair API Developer Guide and Reference April 2007 11OverviewTaking Your Application LiveCreate and Post the RequestCreate an NVP request st

The ASP.NET SDKInstalling the ASP.NET SDK110 April 2007 Name-Value Pair API Developer Guide and ReferenceMinimum Hardware RequirementsThe following ta

Name-Value Pair API Developer Guide and Reference April 2007 111The ASP.NET SDKInstalling the ASP.NET SDKSDK Directories and Optional ConfigurationsTh

The ASP.NET SDKInstalling the ASP.NET SDK112 April 2007 Name-Value Pair API Developer Guide and ReferenceLog LevelsThe SDK varies the amount of detail

Name-Value Pair API Developer Guide and Reference April 2007 113The ASP.NET SDKComplete SDK and API Class Documentation<logger name="com.paypa

The ASP.NET SDKProfiles114 April 2007 Name-Value Pair API Developer Guide and Referencez The URL to which the button form POSTsz The optional URL of a

Name-Value Pair API Developer Guide and Reference April 2007 115The ASP.NET SDKSample ApplicationsSample ApplicationsThe PayPal SDK includes sample ap

The ASP.NET SDKSample API User with API Certificate116 April 2007 Name-Value Pair API Developer Guide and ReferenceSample API User with API Certificat

117 F Country CodesN OTE: This table lists country codes defined by ISO 3166-1.Table 1: Country CodesCountry CodeAFGHANISTAN AFÅLAND ISLANDS AXALBANIA

Country Codes118CHILE CLCHINA CNCHRISTMAS ISLAND CXCOCOS (KEELING) ISLANDS CCCOLOMBIA COCOMOROS KMCONGO CGCONGO, THE DEMOCRATIC REPUBLIC OF THECDCOOK

HEARD ISLAND AND MCDONALD ISLANDSHMHOLY SEE (VATICAN CITY STATE)VAHONDURAS HNHONG KONG HKHUNGARY HUICELAND ISINDIA ININDONESIA IDIRAN, ISLAMIC REPUBLI

OverviewTechnical Details12 April 2007 Name-Value Pair API Developer Guide and ReferenceIMPORTANT: If you are using API signature, you must protect th

Country Codes120MOROCCO MAMOZAMBIQUE MZMYANMAR MMNAMIBIA NANAURU NRNEPAL NPNETHERLANDS NLNETHERLANDS ANTILLES ANNEW CALEDONIA NCNEW ZEALAND NZNICARAGU

SOLOMON ISLANDS SBSOMALIA SOSOUTH AFRICA ZASOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDSGSSPAIN ESSRI LANKA LKSUDAN SDSURINAME SRSVALBARD AND JAN MAYEN

Country Codes122

Name-Value Pair API Developer Guide and Reference March 2007 123IndexAACCT 51ACK 15, 16, 63Add/Remove Programs 113ADDRESSOWNER 55ADDRESSSTATUS 43, 55A

Index124 March 2007 Name-Value Pair API Developer Guide and ReferenceEUR 35Euro 35EWP profiledefined 106, 113EWPProfile interface 107, 114EXCHANGERATE

Name-Value Pair API Developer Guide and Reference March 2007 125IndexDoExpressCheckoutPayment 44GetExpressCheckoutDetails 41GetTransactionDetails 54Ma

Index126 March 2007 Name-Value Pair API Developer Guide and ReferenceREQCONFIRMSHIPPING 38RETRYTIME 59RETURNURL 36Reversed 57Reversed (transaction sta

Name-Value Pair API Developer Guide and Reference March 2007 127IndexColdFusion 13Java 13PHP 13USD 36USER 14USERNAME 59UTC/GMT 53VVERSION 15, 16, 63VE

Name-Value Pair API Developer Guide and Reference April 2007 13OverviewTechnical DetailsURL-EncodingThe request and response are URL-encoded. URL-enco

OverviewTechnical Details14 April 2007 Name-Value Pair API Developer Guide and ReferenceRequest FormatEach NVP request consists of required and option

Name-Value Pair API Developer Guide and Reference April 2007 15OverviewTechnical DetailsYou may see sample code where these values are stored in an HT

OverviewTechnical Details16 April 2007 Name-Value Pair API Developer Guide and ReferenceError ResponsesIf the ACK value is Error or Warning, API respo

Name-Value Pair API Developer Guide and Reference April 2007 172Accepting PayPal in Express CheckoutBy choosing Express Checkout, the customer can sav

Accepting PayPal in Express CheckoutBasic Checkout with PayPal218 April 2007 Name-Value Pair API Developer Guide and Reference1. Starting the Checkout

Name-Value Pair API Developer Guide and Reference April 2007 19Accepting PayPal in Express CheckoutBasic Checkout with PayPal23. Getting Payer Details

PayPal Name-Value Pair API Developer Guide and ReferenceDocument Number: 100018.en_DE-20070410© 2007 PayPal, Inc. All rights reserved. PayPal is a reg

Accepting PayPal in Express CheckoutSupport giropay and electronic funds transfer220 April 2007 Name-Value Pair API Developer Guide and ReferenceSuppo

Name-Value Pair API Developer Guide and Reference April 2007 21Accepting PayPal in Express CheckoutControlling the Shipping Address Using SetExpressCh

Accepting PayPal in Express CheckoutControlling the Shipping Address Using SetExpressCheckout222 April 2007 Name-Value Pair API Developer Guide and Re

Name-Value Pair API Developer Guide and Reference April 2007 23Accepting PayPal in Express CheckoutChanging the Language on the PayPal Login Page Usin

Accepting PayPal in Express CheckoutForm-Filling Your Payment Review Page Using GetExpressCheckoutDetails224 April 2007 Name-Value Pair API Developer

Name-Value Pair API Developer Guide and Reference April 2007 25Accepting PayPal in Express CheckoutMaking a Sale Using DoExpressCheckoutPayment2Get th

Accepting PayPal in Express CheckoutIncluding Line Item Details Using DoExpressCheckoutPayment226 April 2007 Name-Value Pair API Developer Guide and R

Name-Value Pair API Developer Guide and Reference April 2007 27Accepting PayPal in Express CheckoutIncluding Subtotals Using DoExpressCheckoutPayment2

Accepting PayPal in Express CheckoutUpdating the Shipping Address Using DoExpressCheckoutPayment228 April 2007 Name-Value Pair API Developer Guide and

Name-Value Pair API Developer Guide and Reference April 2007 29Accepting PayPal in Express CheckoutUpdating the Shipping Address Using DoExpressChecko

Name-Value Pair API Developer Guide and Reference April 2007 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . .

Accepting PayPal in Express CheckoutUpdating the Shipping Address Using DoExpressCheckoutPayment230 April 2007 Name-Value Pair API Developer Guide and

Name-Value Pair API Developer Guide and Reference April 2007 313Back-Office AdministrationThis section gives you examples of the following functions:z

Back-Office AdministrationSearching for Transactions Using TransactionSearch332 April 2007 Name-Value Pair API Developer Guide and ReferenceIncluding

Name-Value Pair API Developer Guide and Reference April 2007 33Back-Office AdministrationViewing Details of a Single Transaction Using GetTransactionD

Back-Office AdministrationViewing Details of a Single Transaction Using GetTransactionDetails334 April 2007 Name-Value Pair API Developer Guide and Re

A Name-Value Pair API Developer Guide and Reference April 2007 35NVP API Method and Field ReferenceGeneral Characteristics of Requests and Parameters

NVP API Method and Field ReferenceExpress Checkout36 April 2007 Name-Value Pair API Developer Guide and ReferenceExpress CheckoutSetExpressCheckout Re

Name-Value Pair API Developer Guide and Reference April 2007 37NVP API Method and Field ReferenceExpress CheckoutGIROPAYCANCELURL URL of your website

NVP API Method and Field ReferenceExpress Checkout38 April 2007 Name-Value Pair API Developer Guide and ReferenceCUSTOM A free-form field for your own

Name-Value Pair API Developer Guide and Reference April 2007 39NVP API Method and Field ReferenceExpress CheckoutLOCALECODE Locale of pages displayed

Contents4 April 2007 Name-Value Pair API Developer Guide and ReferenceCompleting the Transaction . . . . . . . . . . . . . . . . . .

NVP API Method and Field ReferenceExpress Checkout40 April 2007 Name-Value Pair API Developer Guide and ReferenceShipping Address Optional shipping ad

Name-Value Pair API Developer Guide and Reference April 2007 41NVP API Method and Field ReferenceExpress CheckoutSetExpressCheckout ResponseRedirectin

NVP API Method and Field ReferenceExpress Checkout42 April 2007 Name-Value Pair API Developer Guide and ReferenceGetExpressCheckoutDetails ResponseTAB

Name-Value Pair API Developer Guide and Reference April 2007 43NVP API Method and Field ReferenceExpress CheckoutDoExpressCheckoutPayment RequestReque

NVP API Method and Field ReferenceExpress Checkout44 April 2007 Name-Value Pair API Developer Guide and ReferenceTABLE A.7 DoExpressCheckoutPayment Pa

Name-Value Pair API Developer Guide and Reference April 2007 45NVP API Method and Field ReferenceExpress CheckoutNOTIFYURL Your URL for receiving Inst

NVP API Method and Field ReferenceExpress Checkout46 April 2007 Name-Value Pair API Developer Guide and ReferenceL_NUMBERn Item number.Character lengt

Name-Value Pair API Developer Guide and Reference April 2007 47NVP API Method and Field ReferenceExpress CheckoutDoExpressCheckoutPayment ResponseSHIP

NVP API Method and Field ReferenceExpress Checkout48 April 2007 Name-Value Pair API Developer Guide and ReferencePAYMENTTYPE Indicates whether the pay

Name-Value Pair API Developer Guide and Reference April 2007 49NVP API Method and Field ReferenceExpress CheckoutPAYMENTSTATUS Status of the payment:C

Name-Value Pair API Developer Guide and Reference April 2007 5ContentsRefundTransaction . . . . . . . . . . . . . . . . . . . . .

NVP API Method and Field ReferenceRefundTransaction50 April 2007 Name-Value Pair API Developer Guide and ReferenceRefundTransactionTransactionSearchWi

Name-Value Pair API Developer Guide and Reference April 2007 51NVP API Method and Field ReferenceTransactionSearchTransactionSearch returns up to 100

NVP API Method and Field ReferenceTransactionSearch52 April 2007 Name-Value Pair API Developer Guide and ReferenceMIDDLENAME Buyer’s middle nameCharac

Name-Value Pair API Developer Guide and Reference April 2007 53NVP API Method and Field ReferenceTransactionSearchSTATUS Search by transaction status:

NVP API Method and Field ReferenceGetTransactionDetails54 April 2007 Name-Value Pair API Developer Guide and ReferenceGetTransactionDetailsL_AMTn The

Name-Value Pair API Developer Guide and Reference April 2007 55NVP API Method and Field ReferenceGetTransactionDetailsEMAIL Email address of payerChar

NVP API Method and Field ReferenceGetTransactionDetails56 April 2007 Name-Value Pair API Developer Guide and ReferenceSHIPTOSTATE State or province.Ch

Name-Value Pair API Developer Guide and Reference April 2007 57NVP API Method and Field ReferenceGetTransactionDetailsFEEAMT Transaction fee associate

NVP API Method and Field ReferenceGetTransactionDetails58 April 2007 Name-Value Pair API Developer Guide and ReferencePENDINGREASON N OTE: PendingReas

Name-Value Pair API Developer Guide and Reference April 2007 59NVP API Method and Field ReferenceGetTransactionDetailsL_DESCn Item name set by you or

Contents6 April 2007 Name-Value Pair API Developer Guide and ReferenceAppendix D The Java SDK . . . . . . . . . . . . . . . . . . .

NVP API Method and Field ReferenceMass Payment60 April 2007 Name-Value Pair API Developer Guide and ReferenceMass PaymentRECURRING Indicates whether r

Name-Value Pair API Developer Guide and Reference April 2007 61NVP API Method and Field ReferenceMass PaymentL_UNIQUEIDn Transaction-specific identifi

NVP API Method and Field ReferenceMass Payment62 April 2007 Name-Value Pair API Developer Guide and Reference

B Name-Value Pair API Developer Guide and Reference March 2007 63Error Message ReferenceThis chapter contains error messages for the API.Error Respon

Error Message ReferenceValidation Errors64 March 2007 Name-Value Pair API Developer Guide and Reference81105 Missing Parameter ShipToStreet : Required

Name-Value Pair API Developer Guide and Reference March 2007 65Error Message ReferenceValidation Errors81135 Missing Parameter FirstName : Required pa

Error Message ReferenceValidation Errors66 March 2007 Name-Value Pair API Developer Guide and Reference81219 Invalid Parameter ItemAmt : Invalid param

Name-Value Pair API Developer Guide and Reference March 2007 67Error Message ReferenceGeneral API ErrorsGeneral API ErrorsTABLE B.2 General API Errors

Error Message ReferenceExpress Checkout API Errors68 March 2007 Name-Value Pair API Developer Guide and ReferenceExpress Checkout API Errors10002 Auth

Name-Value Pair API Developer Guide and Reference March 2007 69Error Message ReferenceExpress Checkout API Errors10007 Permission denied You do not ha

Name-Value Pair API Developer Guide and Reference April 2007 7PrefaceThis DocumentThe PayPal Name-Value Pair API Developer Guide and Reference describ

Error Message ReferenceExpress Checkout API Errors70 March 2007 Name-Value Pair API Developer Guide and Reference10410 Invalid token Invalid token.10

Name-Value Pair API Developer Guide and Reference March 2007 71Error Message ReferenceExpress Checkout API Errors10412 Duplicate invoice Payment has a

Error Message ReferenceExpress Checkout API Errors72 March 2007 Name-Value Pair API Developer Guide and Reference10433 Transaction refused because of

Name-Value Pair API Developer Guide and Reference March 2007 73Error Message ReferenceExpress Checkout API Errors10439 Transaction refused because of

Error Message ReferenceExpress Checkout API Errors74 March 2007 Name-Value Pair API Developer Guide and Reference10539 Payment declined by your Risk C

Name-Value Pair API Developer Guide and Reference March 2007 75Error Message ReferenceExpress Checkout API Errors10001 ButtonSource value truncated. T

Error Message ReferenceExpress Checkout API Errors76 March 2007 Name-Value Pair API Developer Guide and Reference10007 Permission denied You do not ha

Name-Value Pair API Developer Guide and Reference March 2007 77Error Message ReferenceExpress Checkout API Errors10004 Transaction refused because of

Error Message ReferenceExpress Checkout API Errors78 March 2007 Name-Value Pair API Developer Guide and Reference10413 Transaction refused because of

Name-Value Pair API Developer Guide and Reference March 2007 79Error Message ReferenceExpress Checkout API Errors10417 Transaction cannot complete. Th

PrefaceRevision History8 April 2007 Name-Value Pair API Developer Guide and ReferenceRevision HistoryRevision history for PayPal Name-Value Pair API D

Error Message ReferenceExpress Checkout API Errors80 March 2007 Name-Value Pair API Developer Guide and Reference10421 This Express Checkout session b

Name-Value Pair API Developer Guide and Reference March 2007 81Error Message ReferenceExpress Checkout API Errors10431 Item amount is invalid. Item am

Error Message ReferenceExpress Checkout API Errors82 March 2007 Name-Value Pair API Developer Guide and Reference10442 ButtonSource value truncated. T

Name-Value Pair API Developer Guide and Reference March 2007 83Error Message ReferenceExpress Checkout API Errors10539 Payment declined by your Risk C

Error Message ReferenceRefundTransaction API Errors84 March 2007 Name-Value Pair API Developer Guide and ReferenceRefundTransaction API ErrorsTABLE B.

Name-Value Pair API Developer Guide and Reference March 2007 85Error Message ReferenceRefundTransaction API Errors10004 Transaction refused because of

Error Message ReferenceRefundTransaction API Errors86 March 2007 Name-Value Pair API Developer Guide and Reference10007 Permission denied You do not h

Name-Value Pair API Developer Guide and Reference March 2007 87Error Message ReferenceTransactionSearch API ErrorsTransactionSearch API Errors10009 Tr

Error Message ReferenceTransactionSearch API Errors88 March 2007 Name-Value Pair API Developer Guide and Reference10004 Transaction refused because of

Name-Value Pair API Developer Guide and Reference March 2007 89Error Message ReferenceGetTransactionDetails API ErrorsGetTransactionDetails API Errors

1Name-Value Pair API Developer Guide and Reference April 2007 9OverviewThis chapter describes the PayPal Name-Value Pair (NVP) API at a high level and

Error Message ReferenceMassPay API Errors90 March 2007 Name-Value Pair API Developer Guide and Reference10001 Transaction refused because of an invali

Name-Value Pair API Developer Guide and Reference March 2007 91Error Message ReferenceMassPay API Errors10004 Transaction refused because of an invali

Error Message ReferenceMassPay API Errors92 March 2007 Name-Value Pair API Developer Guide and Reference10004 Transaction refused because of an invali

Name-Value Pair API Developer Guide and Reference March 2007 93Error Message ReferenceMassPay API Errors10308 Masspay server configuration errorThere

Error Message ReferenceMassPay API Errors94 March 2007 Name-Value Pair API Developer Guide and Reference

C Name-Value Pair API Developer Guide and Reference April 2007 95NVP API Web SamplesThis chapter describes the NVP API Web Samples which access the N

NVP API Web SamplesDescriptions of the Samples96 April 2007 Name-Value Pair API Developer Guide and ReferenceThe primary files for this sample are:TAB

Name-Value Pair API Developer Guide and Reference April 2007 97NVP API Web SamplesDescriptions of the SamplesGetting Transaction DetailsThis sample sh

NVP API Web Samples98 April 2007 Name-Value Pair API Developer Guide and ReferenceCommon FilesThe following files are common to the samples. Sample AP

Name-Value Pair API Developer Guide and Reference April 2007 99NVP API Web SamplesSamples Using PHPSamples Using PHPThis section contains information