PayPal Adaptive Payments - 2012 Guia do Utilizador Página 1

Adaptive Payments Developer GuideLast updated: August 7, 2012

Contents10 August 7, 2012 Adaptive Payments Developer GuidePhoneNumberType Response Fields . . . . . . . . . . . . . . . . . . . .

Pay API OperationPay Examples Using NVP and CURL100 August 7, 2012 Adaptive Payments Developer Guidecurl -s --insecure -H "X-PAYPAL-SECURITY-USER

Adaptive Payments Developer Guide August 7, 2012 101Pay API OperationPay Examples Using NVP and CURLRequest:curl -s --insecure -H "X-PAYPAL-SECUR

Pay API OperationPay Examples Using NVP and CURL102 August 7, 2012 Adaptive Payments Developer Guidecurl -s --insecure -H "X-PAYPAL-SECURITY-USER

Adaptive Payments Developer Guide August 7, 2012 103Pay API OperationPay Examples Using NVP and CURLcurl -s --insecure -H "X-PAYPAL-SECURITY-USER

Pay API OperationPay Errors104 August 7, 2012 Adaptive Payments Developer Guidecurl -s --insecure -H "X-PAYPAL-SECURITY-USERID: api_username"

Adaptive Payments Developer Guide August 7, 2012 105Pay API OperationPay Errors520005 Merchant account is locked520006 This call is not defined in the

Pay API OperationPay Errors106 August 7, 2012 Adaptive Payments Developer Guide579028 The payment amount exceeds the maximum amount per payment579030

Adaptive Payments Developer Guide August 7, 2012 107Pay API OperationPay Errors580023 Invalid request580023 The fee payer <value> cannot be use

Pay API OperationPay Errors108 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 1094PaymentDetails API OperationUse the PaymentDetails API operation to obtain information about a pa

Adaptive Payments Developer Guide August 7, 2012 11ContentsFaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . .

PaymentDetails API OperationPaymentDetailsResponse Message110 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsPaymentDetailsResp

Adaptive Payments Developer Guide August 7, 2012 111PaymentDetails API OperationPaymentDetailsResponse Message

PaymentDetails API OperationPaymentDetailsResponse Message112 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 113PaymentDetails API OperationPaymentDetailsResponse MessagePaymentDetailsResponse FieldsField Descr

PaymentDetails API OperationPaymentDetailsResponse Message114 August 7, 2012 Adaptive Payments Developer GuidecurrencyCode xs:stringThe currency code.

Adaptive Payments Developer Guide August 7, 2012 115PaymentDetails API OperationPaymentDetailsResponse MessagefundingtypeList ap:FundingTypeListSpecif

PaymentDetails API OperationPaymentDetailsResponse Message116 August 7, 2012 Adaptive Payments Developer GuideFundingTypeList FieldsFundingTypeInfo Fi

Adaptive Payments Developer Guide August 7, 2012 117PaymentDetails API OperationPaymentDetailsResponse MessagePaymentInfoList FieldsPaymentInfo Fields

PaymentDetails API OperationPaymentDetailsResponse Message118 August 7, 2012 Adaptive Payments Developer GuideReceiver Fieldsreceiver ap:ReceiverThe r

Adaptive Payments Developer Guide August 7, 2012 119PaymentDetails API OperationPaymentDetailsResponse MessageSenderIdentifier Fieldsemail xs:stringRe

Contents12 August 7, 2012 Adaptive Payments Developer GuideNew InvoiceItem Structure for Version 1.6.0 . . . . . . . . . . . . . . .

PaymentDetails API OperationPaymentDetailsResponse Message120 August 7, 2012 Adaptive Payments Developer GuideTaxIdDetails FieldsAccountIdentifier Fie

Adaptive Payments Developer Guide August 7, 2012 121PaymentDetails API OperationPPFault MessagePPFault MessageThe PPFaultMessage returns ErrorData and

PaymentDetails API OperationPPFault Message122 August 7, 2012 Adaptive Payments Developer GuideFaultMessage FieldsErrorData FieldsField Descriptionerr

Adaptive Payments Developer Guide August 7, 2012 123PaymentDetails API OperationPaymentDetails Examples Using NVP and CURLResponseEnvelope FieldsPayme

PaymentDetails API OperationPaymentDetails Examples Using NVP and CURL124 August 7, 2012 Adaptive Payments Developer Guideis a single line and each re

Adaptive Payments Developer Guide August 7, 2012 125PaymentDetails API OperationPayment Details ErrorsPayment Details ErrorsCode Message Additional In

PaymentDetails API OperationPayment Details Errors126 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 1275ExecutePayment API OperationThe ExecutePayment API operation lets you execute a payment set up wi

ExecutePayment API OperationExecutePaymentResponse Message128 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsExecutePaymentResp

Adaptive Payments Developer Guide August 7, 2012 129ExecutePayment API OperationExecutePaymentResponse Message

Adaptive Payments Developer Guide August 7, 2012 13Contents

ExecutePayment API OperationExecutePaymentResponse Message130 August 7, 2012 Adaptive Payments Developer GuideExecutePaymentResponse FieldsPayErrorLis

Adaptive Payments Developer Guide August 7, 2012 131ExecutePayment API OperationExecutePaymentResponse MessageErrorData FieldsReceiver FieldsField Des

ExecutePayment API OperationExecutePaymentResponse Message132 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldspaymentType xs:st

Adaptive Payments Developer Guide August 7, 2012 133ExecutePayment API OperationPPFault MessagePPFault MessageThe PPFaultMessage returns ErrorData and

ExecutePayment API OperationPPFault Message134 August 7, 2012 Adaptive Payments Developer GuideFaultMessage FieldsErrorData FieldsField Descriptionerr

Adaptive Payments Developer Guide August 7, 2012 135ExecutePayment API OperationExecutePayment ErrorsResponseEnvelope FieldsExecutePayment ErrorsField

ExecutePayment API OperationExecutePayment Errors136 August 7, 2012 Adaptive Payments Developer Guide539041 The email account is based in a country th

Adaptive Payments Developer Guide August 7, 2012 137ExecutePayment API OperationExecutePayment Errors579027 The preapproval key specifies a different

ExecutePayment API OperationExecutePayment Errors138 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 1396GetPaymentOptions API OperationYou use the GetPaymentOptions API operation to retrieve the paymen

Contents14 August 7, 2012 Adaptive Payments Developer Guide

GetPaymentOptions API OperationGetPaymentOptionsResponse Message140 August 7, 2012 Adaptive Payments Developer GuideGetPaymentOptionsResponse Messagee

Adaptive Payments Developer Guide August 7, 2012 141GetPaymentOptions API OperationGetPaymentOptionsResponse MessageGetPaymentOptionsResponse FieldsFi

GetPaymentOptions API OperationGetPaymentOptionsResponse Message142 August 7, 2012 Adaptive Payments Developer GuideDisplayOptions FieldsDisplayOption

Adaptive Payments Developer Guide August 7, 2012 143GetPaymentOptions API OperationGetPaymentOptionsResponse MessageInitiatingEntity FieldsInstitution

GetPaymentOptions API OperationGetPaymentOptionsResponse Message144 August 7, 2012 Adaptive Payments Developer GuideSenderOptions FieldsReceiverOption

Adaptive Payments Developer Guide August 7, 2012 145GetPaymentOptions API OperationGetPaymentOptionsResponse MessageInvoiceItem FieldsReceiverIdentifi

GetPaymentOptions API OperationPPFault Message146 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldsPPFault MessageThe PPFaultMes

Adaptive Payments Developer Guide August 7, 2012 147GetPaymentOptions API OperationPPFault MessageFaultMessage FieldsField Descriptionerror common:Err

GetPaymentOptions API OperationPPFault Message148 August 7, 2012 Adaptive Payments Developer GuideErrorData FieldsResponseEnvelope FieldsField Descrip

Adaptive Payments Developer Guide August 7, 2012 149GetPaymentOptions API OperationGetPaymentOptions ErrorsGetPaymentOptions ErrorscorrelationId xs:st

Adaptive Payments Developer Guide August 7, 2012 15 What’s New?Adaptive Payments is intended for developers implementing payment solutions with PayPal

GetPaymentOptions API OperationGetPaymentOptions Errors150 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 1517SetPaymentOptions API OperationYou use the SetPaymentOptions API operation to specify settings fo

SetPaymentOptions API OperationSetPaymentsOptionsRequest Message152 August 7, 2012 Adaptive Payments Developer GuideSetPaymentOptionsRequest FieldsFie

Adaptive Payments Developer Guide August 7, 2012 153SetPaymentOptions API OperationSetPaymentsOptionsRequest MessageDisplayOptions FieldsInitiatingEnt

SetPaymentOptions API OperationSetPaymentsOptionsRequest Message154 August 7, 2012 Adaptive Payments Developer GuideInstitution Customer FieldsSenderO

Adaptive Payments Developer Guide August 7, 2012 155SetPaymentOptions API OperationSetPaymentsOptionsRequest MessageReceiverOptions FieldsInvoiceData

SetPaymentOptions API OperationSetPaymentsOptionsRequest Message156 August 7, 2012 Adaptive Payments Developer GuideReceiverIdentifier FieldsPhoneNumb

Adaptive Payments Developer Guide August 7, 2012 157SetPaymentOptions API OperationSetPaymentOptionsResponse MessageSetPaymentOptionsResponse MessageR

SetPaymentOptions API OperationPPFault Message158 August 7, 2012 Adaptive Payments Developer GuidePPFault MessageThe PPFaultMessage returns ErrorData

Adaptive Payments Developer Guide August 7, 2012 159SetPaymentOptions API OperationPPFault MessageErrorData FieldsResponseEnvelope FieldsField Descrip

1.8.1 Features16 August 7, 2012 Adaptive Payments Developer Guide

SetPaymentOptions API OperationSetPaymentOptions Examples Using NVP and CURL160 August 7, 2012 Adaptive Payments Developer GuideSetPaymentOptions Exam

Adaptive Payments Developer Guide August 7, 2012 161SetPaymentOptions API OperationSetPaymentOptions Errorscurl -s --insecure -H "X-PAYPAL-SECURI

SetPaymentOptions API OperationSetPaymentOptions Errors162 August 7, 2012 Adaptive Payments Developer Guide580022  Invalid request parameter: <val

Adaptive Payments Developer Guide August 7, 2012 1638Preapproval API OperationUse the Preapproval API operation to set up an agreement between yoursel

Preapproval API OperationPreapprovalRequest Message164 August 7, 2012 Adaptive Payments Developer Guide PayPal sends an email to the sender that conf

Adaptive Payments Developer Guide August 7, 2012 165Preapproval API OperationPreapprovalRequest MessagePreapprovalRequest FieldsField Descriptioncance

Preapproval API OperationPreapprovalRequest Message166 August 7, 2012 Adaptive Payments Developer GuidecurrencyCode xs:string(Required) The currency c

Adaptive Payments Developer Guide August 7, 2012 167Preapproval API OperationPreapprovalRequest MessagedayOfWeek common:DayOfWeek(Optional) The day of

Preapproval API OperationPreapprovalRequest Message168 August 7, 2012 Adaptive Payments Developer GuidepaymentPeriod xs:string(Optional) The payment p

Adaptive Payments Developer Guide August 7, 2012 169Preapproval API OperationPreapprovalRequest MessageClientDetails Fields feesPayer xs:string(Option

Adaptive Payments Developer Guide August 7, 2012 171Introducing Adaptive PaymentsThe Adaptive Payments API enables you to send money in many different

Preapproval API OperationPreapprovalResponse Message170 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsPreapprovalResponse Mess

Adaptive Payments Developer Guide August 7, 2012 171Preapproval API OperationPPFault MessageResponseEnvelope FieldsPPFault MessageThe PPFaultMessage r

Preapproval API OperationPPFault Message172 August 7, 2012 Adaptive Payments Developer GuideFaultMessage FieldsField Descriptionerror common:ErrorData

Adaptive Payments Developer Guide August 7, 2012 173Preapproval API OperationPPFault MessageErrorData FieldsResponseEnvelope FieldsField Descriptionca

Preapproval API OperationPreapproval Examples Using NVP and CURL174 August 7, 2012 Adaptive Payments Developer GuidePreapproval Examples Using NVP and

Adaptive Payments Developer Guide August 7, 2012 175Preapproval API OperationPreapproval Errorscurl -s --insecure -H "X-PAYPAL-SECURITY-USERID: a

Preapproval API OperationPreapproval Errors176 August 7, 2012 Adaptive Payments Developer Guide580001 Invalid request580022 Account already exists Sin

Adaptive Payments Developer Guide August 7, 2012 1779PreapprovalDetails API OperationUse the PreapprovalDetails API operation to obtain information ab

PreapprovalDetails API OperationPreapprovalDetailsResponse Message178 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsPreapprova

Adaptive Payments Developer Guide August 7, 2012 179PreapprovalDetails API OperationPreapprovalDetailsResponse Message

Introducing Adaptive PaymentsAdaptive Payments Actors and Objects18 August 7, 2012 Adaptive Payments Developer GuideYou are not required to be a recei

PreapprovalDetails API OperationPreapprovalDetailsResponse Message180 August 7, 2012 Adaptive Payments Developer GuidePreapprovalDetailsResponse Field

Adaptive Payments Developer Guide August 7, 2012 181PreapprovalDetails API OperationPreapprovalDetailsResponse MessagecurrencyCode The currency code r

PreapprovalDetails API OperationPreapprovalDetailsResponse Message182 August 7, 2012 Adaptive Payments Developer GuidedayOfWeek The day of the week th

Adaptive Payments Developer Guide August 7, 2012 183PreapprovalDetails API OperationPreapprovalDetailsResponse MessageAddressList FieldsAddress Fields

PreapprovalDetails API OperationPreapprovalDetailsResponse Message184 August 7, 2012 Adaptive Payments Developer GuideBaseAddress FieldsResponseEnvelo

Adaptive Payments Developer Guide August 7, 2012 185PreapprovalDetails API OperationPPFault MessagePPFault MessageThe PPFaultMessage returns ErrorData

PreapprovalDetails API OperationPPFault Message186 August 7, 2012 Adaptive Payments Developer GuideFaultMessage FieldsErrorData FieldsField Descriptio

Adaptive Payments Developer Guide August 7, 2012 187PreapprovalDetails API OperationPreapprovalDetails Examples Using NVP and CURLResponseEnvelope Fie

PreapprovalDetails API OperationPreapprovalDetails Examples Using NVP and CURL188 August 7, 2012 Adaptive Payments Developer Guidecommand is a single

Adaptive Payments Developer Guide August 7, 2012 189PreapprovalDetails API OperationPreapproval Details ErrorsPreapproval Details ErrorsCode Message A

Adaptive Payments Developer Guide August 7, 2012 19Introducing Adaptive PaymentsSimple, Parallel, and Chained PaymentsFor example, you might use this

PreapprovalDetails API OperationPreapproval Details Errors190 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 19110CancelPreapproval API OperationUse the CancelPreapproval API operation to handle the canceling o

CancelPreapproval API OperationCancelPreapprovalResponse Message192 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsCancelPreapp

Adaptive Payments Developer Guide August 7, 2012 193CancelPreapproval API OperationPPFault MessageResponseEnvelope FieldsPPFault MessageThe PPFaultMes

CancelPreapproval API OperationPPFault Message194 August 7, 2012 Adaptive Payments Developer GuideFaultMessage FieldsField Descriptionerror common:Err

Adaptive Payments Developer Guide August 7, 2012 195CancelPreapproval API OperationPPFault MessageErrorData FieldsResponseEnvelope FieldsField Descrip

CancelPreapproval API OperationCancelPreapproval Errors196 August 7, 2012 Adaptive Payments Developer GuideCancelPreapproval ErrorscorrelationId xs:st

Adaptive Payments Developer Guide August 7, 2012 19711ConvertCurrency API OperationUse the ConvertCurrency API operation to obtain the estimated curre

ConvertCurrency API OperationConvertCurrencyRequest Message198 August 7, 2012 Adaptive Payments Developer GuideCurrencyType FieldsField Descriptionbas

Adaptive Payments Developer Guide August 7, 2012 199ConvertCurrency API OperationConvertCurrencyRequest Messagecode xs:string(Required) The currency c

Adaptive Payments Developer GuideDocument Number: 10097.en_US-20120807© 2010-2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark o

Introducing Adaptive PaymentsSimple, Parallel, and Chained Payments20 August 7, 2012 Adaptive Payments Developer GuideSimple PaymentsSimple payments e

ConvertCurrency API OperationConvertCurrencyRequest Message200 August 7, 2012 Adaptive Payments Developer GuideCurrencyList FieldsField Descriptioncur

Adaptive Payments Developer Guide August 7, 2012 201ConvertCurrency API OperationConvertCurrencyRequest MessageCurrencyCodeList FieldsField Descriptio

ConvertCurrency API OperationConvertCurrencyResponse Message202 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsConversionType F

Adaptive Payments Developer Guide August 7, 2012 203ConvertCurrency API OperationConvertCurrencyResponse MessageConversionCurrencyResponse FieldsCurre

ConvertCurrency API OperationConvertCurrencyResponse Message204 August 7, 2012 Adaptive Payments Developer GuideCurrencyConversionList FieldsCurrencyT

Adaptive Payments Developer Guide August 7, 2012 205ConvertCurrency API OperationConvertCurrencyResponse MessageCurrencyList Fieldscode xs:stringThe c

ConvertCurrency API OperationPPFault Message206 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldsPPFault MessageThe PPFaultMessa

Adaptive Payments Developer Guide August 7, 2012 207ConvertCurrency API OperationPPFault MessageFaultMessage FieldsField Descriptionerror common:Error

ConvertCurrency API OperationPPFault Message208 August 7, 2012 Adaptive Payments Developer GuideErrorData FieldsResponseEnvelope FieldsField Descripti

Adaptive Payments Developer Guide August 7, 2012 209ConvertCurrency API OperationConvertCurrency ErrorsConvertCurrency ErrorscorrelationId xs:stringCo

Adaptive Payments Developer Guide August 7, 2012 21Introducing Adaptive PaymentsSimple, Parallel, and Chained PaymentsNOTE: This scenario is an exampl

ConvertCurrency API OperationConvertCurrency Errors210 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 21112Refund API OperationUse the Refund API operation to refund all or part of a payment. You can spe

Refund API OperationRefund API Overview212 August 7, 2012 Adaptive Payments Developer GuideCommon fields for all refundsYou can refund a payment from

Adaptive Payments Developer Guide August 7, 2012 213Refund API OperationRefund API OverviewRefunds that apply to a PayPal transaction associated with

Refund API OperationRefundRequest Message214 August 7, 2012 Adaptive Payments Developer Guide6. If the refund involves chained payments, PayPal first

Adaptive Payments Developer Guide August 7, 2012 215Refund API OperationRefundRequest MessageRefundRequest FieldsYou must specify a value for only one

Refund API OperationRefundRequest Message216 August 7, 2012 Adaptive Payments Developer GuideField DescriptioncurrencyCode (Required) The currency cod

Adaptive Payments Developer Guide August 7, 2012 217Refund API OperationRefundRequest MessageReceiverList FieldsReceiver FieldsreceiverList ap:Receive

Refund API OperationRefundRequest Message218 August 7, 2012 Adaptive Payments Developer GuidePhoneNumberType FieldsRequestEnvelope FieldspaymentSubTyp

Adaptive Payments Developer Guide August 7, 2012 219Refund API OperationRefund Response MessageRefund Response MessageThe refundResponse message conta

Introducing Adaptive PaymentsPayment Approval22 August 7, 2012 Adaptive Payments Developer GuideIn this example, the primary receiver receives $100 fr

Refund API OperationRefund Response Message220 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 221Refund API OperationRefund Response MessageRefundResponse FieldsField DescriptioncurrencyCode The

Refund API OperationRefund Response Message222 August 7, 2012 Adaptive Payments Developer GuideRefundInfoList FieldsRefundInfo FieldsField Description

Adaptive Payments Developer Guide August 7, 2012 223Refund API OperationRefund Response MessagerefundStatus xs:stringStatus of the refund. It is one o

Refund API OperationRefund Response Message224 August 7, 2012 Adaptive Payments Developer GuideErrorData FieldsReceiver FieldsField Descriptioncategor

Adaptive Payments Developer Guide August 7, 2012 225Refund API OperationRefund Response MessagePhoneNumberType Response FieldsResponseEnvelope Fieldsp

Refund API OperationPPFault Message226 August 7, 2012 Adaptive Payments Developer GuidePPFault MessageThe PPFaultMessage returns ErrorData and the Res

Adaptive Payments Developer Guide August 7, 2012 227Refund API OperationPPFault MessageFaultMessage FieldsErrorData FieldsField Descriptionerror commo

Refund API OperationPPFault Message228 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope Fieldsseverity common:ErrorSeverity The severi

Adaptive Payments Developer Guide August 7, 2012 229Refund API OperationRefund Examples Using NVP and CURLRefund Examples Using NVP and CURLThese exam

Adaptive Payments Developer Guide August 7, 2012 23Introducing Adaptive PaymentsAdaptive Payments Service Permissions Preapproved payments, in which

Refund API OperationRefund Errors230 August 7, 2012 Adaptive Payments Developer GuideresponseEnvelope.timestamp=2009-08-14T09%3A00%3A37.748-07%3A00 &a

Adaptive Payments Developer Guide August 7, 2012 231Refund API OperationRefund Errors560018 You cannot refund this type of transaction570012 Cannot do

Refund API OperationRefund Errors232 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 23313GetFundingPlans API OperationUse the GetFundingPlans API operation to determine the funding sour

GetFundingPlans API OperationGetFundingPlansResponse Message234 August 7, 2012 Adaptive Payments Developer GuideGetFundingPlansRequest FieldsRequestEn

Adaptive Payments Developer Guide August 7, 2012 235GetFundingPlans API OperationGetFundingPlansResponse Message

GetFundingPlans API OperationGetFundingPlansResponse Message236 August 7, 2012 Adaptive Payments Developer GuideGetFundingPlansResponse FieldsFundingP

Adaptive Payments Developer Guide August 7, 2012 237GetFundingPlans API OperationGetFundingPlansResponse MessageCurrencyType FieldscurrencyConversion

GetFundingPlans API OperationGetFundingPlansResponse Message238 August 7, 2012 Adaptive Payments Developer GuideFundingSource Fieldscode xs:stringThe

Adaptive Payments Developer Guide August 7, 2012 239GetFundingPlans API OperationGetFundingPlansResponse MessageCurrencyConversion FieldsResponseEnvel

Introducing Adaptive PaymentsExplicit Approval Payment Flow24 August 7, 2012 Adaptive Payments Developer GuideThe following diagram shows the basic fl

GetFundingPlans API OperationPPFault Message240 August 7, 2012 Adaptive Payments Developer GuidePPFault MessageThe PPFaultMessage returns ErrorData an

Adaptive Payments Developer Guide August 7, 2012 241GetFundingPlans API OperationPPFault MessageFaultMessage FieldsErrorData FieldsField Descriptioner

GetFundingPlans API OperationGetFundingPlan Errors242 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldsGetFundingPlan Errorsseve

Adaptive Payments Developer Guide August 7, 2012 243GetFundingPlans API OperationGetFundingPlan Errors520003 Authentication failed. API credentials ar

GetFundingPlans API OperationGetFundingPlan Errors244 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 24514GetShippingAddresses API OperationUse the GetShippingAddresses API operation to obtain the selec

GetShippingAddresses API OperationGetShippingAddressesResponse Message246 August 7, 2012 Adaptive Payments Developer GuideRequestEnvelope FieldsGetShi

Adaptive Payments Developer Guide August 7, 2012 247GetShippingAddresses API OperationGetShippingAddressesResponse MessageGetShippingAddressesResponse

GetShippingAddresses API OperationPPFault Message248 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldsPPFault MessageThe PPFault

Adaptive Payments Developer Guide August 7, 2012 249GetShippingAddresses API OperationPPFault MessageFaultMessage FieldsField Descriptionerror common:

Adaptive Payments Developer Guide August 7, 2012 25Introducing Adaptive PaymentsPreapproved Payments FlowPreapproved Payments FlowPreapproved payments

GetShippingAddresses API OperationPPFault Message250 August 7, 2012 Adaptive Payments Developer GuideErrorData FieldsResponseEnvelope FieldsField Desc

Adaptive Payments Developer Guide August 7, 2012 251GetShippingAddresses API OperationGetShippingAddresses ErrorsGetShippingAddresses Errorscorrelatio

GetShippingAddresses API OperationGetShippingAddresses Errors252 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 25315Adaptive Payment Commands and RedirectsThe web flows associated with Adaptive Payments may requi

Adaptive Payment Commands and RedirectsEmbedded Payment Flow Redirect254 August 7, 2012 Adaptive Payments Developer Guide_ap-preapproval CommandThe se

Adaptive Payments Developer Guide August 7, 2012 255Adaptive Payment Commands and RedirectsEmbedded Payment Flow RedirectJavaScript Functions for Embe

Adaptive Payment Commands and RedirectsEmbedded Payment Flow Redirect256 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 25716Instant Payment NotificationsPayPal sends an IPN message in response to a payment, a refund, cre

Instant Payment NotificationsPay Message Variables258 August 7, 2012 Adaptive Payments Developer Guidestatus The status of the payment. Possible value

Adaptive Payments Developer Guide August 7, 2012 259Instant Payment NotificationsPay Message Variablestransaction[n].status_for _sender_txnThe transac

Introducing Adaptive PaymentsPreapproved Payments Flow26 August 7, 2012 Adaptive Payments Developer Guide2. PayPal responds with a key, called a preap

Instant Payment NotificationsPreapproval Message Variables260 August 7, 2012 Adaptive Payments Developer GuidePreapproval Message VariablesPayPal gene

Adaptive Payments Developer Guide August 7, 2012 261Instant Payment NotificationsPreapproval Message Variablescurrent_total_amount_of_all_paymentsThe

Instant Payment NotificationsPreapproval Message Variables262 August 7, 2012 Adaptive Payments Developer Guideday_of_week The day of the week that a w

Adaptive Payments Developer Guide August 7, 2012 263 Older Versions of the Adaptive Payments APIOlder versions of the Adaptive Payments API can still

1.8.0 Features264 August 7, 2012 Adaptive Payments Developer GuideChanges to ConvertCurrencyRequest Fields for Version 1.8.0Changes to JavaScript Func

Adaptive Payments Developer Guide August 7, 2012 2651.7.0 FeaturesMinibrowser code<form id="mini-form" action="https://www.paypal.co

1.6.0 Features266 August 7, 2012 Adaptive Payments Developer GuideNew API Operations for Version 1.7.0Changes to ConfirmPreapprovalRequest Fields for

Adaptive Payments Developer Guide August 7, 2012 2671.6.0 FeaturesChanges to PayRequest Fields for Version 1.6.0Changes to PayResponse Fields for Vers

1.6.0 Features268 August 7, 2012 Adaptive Payments Developer GuideChanges to SetPaymentOptionsRequest Fields for Version 1.6.0Changes to PreapprovalRe

Adaptive Payments Developer Guide August 7, 2012 2691.6.0 FeaturesNew CurrencyConversion Structure for Version 1.6.0 New InvoiceData Structure for Ver

Adaptive Payments Developer Guide August 7, 2012 27Introducing Adaptive PaymentsImplicit Approval Payments FlowImplicit Approval Payments FlowImplicit

1.6.0 Features270 August 7, 2012 Adaptive Payments Developer GuideNew SenderIdentifier Structure for Version 1.6.0New AccountIdentifier Structure for

Adaptive Payments Developer Guide August 7, 2012 2711.6.0 FeaturesAdditional Error Messages for Version 1.6.0Code Message520003 Authentication failed.

1.6.0 Features272 August 7, 2012 Adaptive Payments Developer Guide580022  Invalid request parameter: <value> The clientDetails parameter is mi

Adaptive Payments Developer Guide August 7, 2012 2731.5.0 Features1.5.0 FeaturesAdaptive Payments version 1.5.0 provides the new features for the APIs

1.4.0 Features274 August 7, 2012 Adaptive Payments Developer GuidePaymentDetails Pending Reason Feature in Version 1.5.0The PaymentDetailsResponse now

Adaptive Payments Developer Guide August 7, 2012 2751.4.0 FeaturesGetPaymentOptions Retrieve payment settings specified with the SetPaymentOptions API

1.4.0 Features276 August 7, 2012 Adaptive Payments Developer GuideChanges to the Pay API OperationChanges to PayRequest and PayResponse MessageChanges

Adaptive Payments Developer Guide August 7, 2012 2771.4.0 FeaturespaymentType New person-to-person values PERSONAL and CASHADVANCE.Allowable values ar

1.4.0 Features278 August 7, 2012 Adaptive Payments Developer GuideChanges to the PreapprovalDetails API OperationChanges to PreapprovalDetailsRequest

Adaptive Payments Developer Guide August 7, 2012 2791.3.0 FeaturesChanges to the Refund API OperationChanges to RefundRequest and RefundResponse Messa

Introducing Adaptive PaymentsEmbedded Payments28 August 7, 2012 Adaptive Payments Developer GuideEmbedded Payment Flow PresentationsPayPal provides th

1.3.0 Features280 August 7, 2012 Adaptive Payments Developer Guidecurrent Foreign Exchange rate. For more information, refer to the ConvertCurrenty AP

Adaptive Payments Developer Guide August 7, 2012 2811.3.0 FeaturesChanges to the Pay API Operation for Version 1.3.0Changes to PayRequest MessageField

1.3.0 Features282 August 7, 2012 Adaptive Payments Developer GuideReceiver.email xs:stringIn this release, the receiver’s email address does not need

Adaptive Payments Developer Guide August 7, 2012 2831.3.0 FeaturesChanges to the PaymentDetails API Operation for Version 1.3.0Changes to PaymentDetai

1.2.0 Features284 August 7, 2012 Adaptive Payments Developer Guide1.2.0 FeaturesVersion 1.2.0 of the Adaptive Payments API introduces changes to sever

Adaptive Payments Developer Guide August 7, 2012 2851.2.0 FeaturesChanges to the Pay API Operation for Version 1.2.0Changes to PayRequest messagesChan

1.1.0 Features286 August 7, 2012 Adaptive Payments Developer GuideChanges to Preapproval API Operation for Version 1.2.0Changes to PreapprovalRequest

Adaptive Payments Developer Guide August 7, 2012 2871.1.0 FeaturesChanges to the Pay API Operation for Version 1.1.0Changes to PayRequest messageChang

1.1.0 Features288 August 7, 2012 Adaptive Payments Developer Guide580022 Invalid request: ~1 Invalid request parameter; for example an invalid applica

Adaptive Payments Developer Guide August 7, 2012 2891.1.0 FeaturesChanges to Preapproval API Operation for Version 1.1.0Changes to PreapprovalRequest

Adaptive Payments Developer Guide August 7, 2012 29Introducing Adaptive PaymentsEmbedded Payments The payment flow can be embedded as a lightbox in a

1.1.0 Features290 August 7, 2012 Adaptive Payments Developer GuideChanges to RefundResponse messageNew Refund error messagesField DescriptionrefundInf

Adaptive Payments Developer Guide August 7, 2012 291 Revision HistoryThe revision history identifies changes to Adaptive Payments documentation at a h

292 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 293IndexSymbols_ap-payment flow command 253_ap-preapproval flow command 254Aack response field 96, 98

Index294 August 7, 2012 Adaptive Payments Developer GuidecurrencyConversionList response field 203CurrencyConversionList response fields 204CurrencyCo

Adaptive Payments Developer Guide August 7, 2012 295IndexFundingTypeInfo request fields 84fundingTypeInfo response field 116FundingTypeInfo response f

Index296 August 7, 2012 Adaptive Payments Developer GuideNname request field 155name response field 145Pparameter field 94, 98, 122, 131, 134, 148, 15

Adaptive Payments Developer Guide August 7, 2012 297IndexrefundTransactionStatus response field 223req uestenvelope request field 81requestEnvelope re

Index298 August 7, 2012 Adaptive Payments Developer GuideUuseCredentials request field 86useCredentials response field 15, 119, 120

Adaptive Payments Developer Guide August 7, 2012 3ContentsWhat’s New?. . . . . . . . . . . . . . . . . . . . . . . . . . .

Introducing Adaptive PaymentsEmbedded Payments30 August 7, 2012 Adaptive Payments Developer GuideYou choose your preferred visual presentation when yo

Adaptive Payments Developer Guide August 7, 2012 31Introducing Adaptive PaymentsEmbedded PaymentsIMPORTANT: Payments for digital goods must use the em

Introducing Adaptive PaymentsEmbedded Payments32 August 7, 2012 Adaptive Payments Developer GuideThe IFRAME also allows the sender to sign up for a Pa

Adaptive Payments Developer Guide August 7, 2012 33Introducing Adaptive PaymentsEmbedded PaymentsThe checkbox controls the remember me behavior for lo

Introducing Adaptive PaymentsEmbedded Payments34 August 7, 2012 Adaptive Payments Developer GuideIf the sender chooses Cancel, PayPal redirects the se

Adaptive Payments Developer Guide August 7, 2012 35Introducing Adaptive PaymentsEmbedded PaymentsWhen the sender clicks Close, PayPal redirects the se

Introducing Adaptive PaymentsEmbedded Payments36 August 7, 2012 Adaptive Payments Developer GuideThe lightbox containing the confirmation would appear

Adaptive Payments Developer Guide August 7, 2012 37Introducing Adaptive PaymentsEmbedded PaymentsPreapprove Future Payments CheckboxYou can add a Prea

Introducing Adaptive PaymentsEmbedded Payments38 August 7, 2012 Adaptive Payments Developer GuideIf the payment sender checks the preapproval box, the

Adaptive Payments Developer Guide August 7, 2012 39Introducing Adaptive PaymentsEmbedded PaymentsNOTE: Unless there is an error with the payment itsel

Contents4 August 7, 2012 Adaptive Payments Developer GuideChapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . .

Introducing Adaptive PaymentsEmbedded Payments40 August 7, 2012 Adaptive Payments Developer GuideThe sender of a payment can select one of the availab

Adaptive Payments Developer Guide August 7, 2012 41Introducing Adaptive PaymentsEmbedded PaymentsIFRAME within the sender’s browser and as a pop-up mi

Introducing Adaptive PaymentsEmbedded Payments42 August 7, 2012 Adaptive Payments Developer GuideThe checkbox controls the remember me behavior for lo

Adaptive Payments Developer Guide August 7, 2012 43Introducing Adaptive PaymentsEmbedded PaymentsIf the sender chooses Cancel, PayPal redirects the se

Introducing Adaptive PaymentsEmbedded Payments44 August 7, 2012 Adaptive Payments Developer GuideWhen the sender clicks Close, PayPal redirects the se

Adaptive Payments Developer Guide August 7, 2012 45Introducing Adaptive PaymentsEmbedded PaymentsThe lightbox containing the confirmation would appear

Introducing Adaptive PaymentsEmbedded Payments46 August 7, 2012 Adaptive Payments Developer GuideThe actions you take to launch the flow and close the

Adaptive Payments Developer Guide August 7, 2012 47Introducing Adaptive PaymentsEmbedded PaymentsIf the payment sender checks the preapproval box, the

Introducing Adaptive PaymentsEmbedded Payments48 August 7, 2012 Adaptive Payments Developer GuideNOTE: Unless there is an error with the payment itsel

Adaptive Payments Developer Guide August 7, 2012 49Introducing Adaptive PaymentsEmbedded PaymentsAfter signing in, the user is presented with a consen

Adaptive Payments Developer Guide August 7, 2012 5ContentsPhoneNumberType Fields . . . . . . . . . . . . . . . . . . . . . . .

Introducing Adaptive PaymentsEmbedded Payments50 August 7, 2012 Adaptive Payments Developer GuideIf the seller has enabled PIN code entry, after conse

Adaptive Payments Developer Guide August 7, 2012 51Introducing Adaptive PaymentsEmbedded PaymentsFinally, the user is presented with a confirmation sc

Introducing Adaptive PaymentsEmbedded Payments52 August 7, 2012 Adaptive Payments Developer GuideShipping Address SelectionYou can display and collect

Adaptive Payments Developer Guide August 7, 2012 53Introducing Adaptive PaymentsEmbedded PaymentsThe sender of a payment can select one of the availab

Introducing Adaptive PaymentsEmbedded Payments54 August 7, 2012 Adaptive Payments Developer GuideAfter the sender of the payment clicks Pay, PayPal di

Adaptive Payments Developer Guide August 7, 2012 55Introducing Adaptive PaymentsEmbedded PaymentsYou can call the GetShippingAddresses API operation t

Introducing Adaptive PaymentsEmbedded Payments56 August 7, 2012 Adaptive Payments Developer Guide1. Call the Pay API operation to obtain a valid pay k

Adaptive Payments Developer Guide August 7, 2012 57Introducing Adaptive PaymentsEmbedded PaymentsSetting Up Web Pages to Invoke the Embedded Payment F

Introducing Adaptive PaymentsEmbedded Payments58 August 7, 2012 Adaptive Payments Developer Guide4. Create an embedded flow object and associate it wi

Adaptive Payments Developer Guide August 7, 2012 59Introducing Adaptive PaymentsGuest Payments3. Redirect the payment sender’s browser to the embedded

Contents6 August 7, 2012 Adaptive Payments Developer GuidePPFault Message . . . . . . . . . . . . . . . . . . . . . . . . .

Introducing Adaptive PaymentsFee Payment Configuration60 August 7, 2012 Adaptive Payments Developer GuideNOTE: For European Union countries, only 10 g

Adaptive Payments Developer Guide August 7, 2012 61Introducing Adaptive PaymentsFee Payment Configurationprimary receiver in a chained payment pays th

Introducing Adaptive PaymentsFee Payment Configuration62 August 7, 2012 Adaptive Payments Developer GuideNOTE: The scenario above is an example only a

Adaptive Payments Developer Guide August 7, 2012 63Introducing Adaptive PaymentsFee Payment ConfigurationIn this example, the primary receiver, identi

Introducing Adaptive PaymentsFee Payment Configuration64 August 7, 2012 Adaptive Payments Developer GuideNOTE: The scenario above is an example only a

Adaptive Payments Developer Guide August 7, 2012 652Getting StartedThese basic scenarios get you up and running quickly with the Adaptive Payments API

Getting StartedAdaptive Payments Endpoints66 August 7, 2012 Adaptive Payments Developer GuideOther API OperationsAdaptive Payments EndpointsThe endpoi

Adaptive Payments Developer Guide August 7, 2012 67Getting StartedHTTP HeadersFor SOAP, you must also include a specific SOAP protocol header (see the

Getting StartedHTTP Headers68 August 7, 2012 Adaptive Payments Developer GuideFor SOAP messages, refer to the next section.HTTP Headers for JSON, NVP,

Adaptive Payments Developer Guide August 7, 2012 69Getting StartedMaking a Simple Payment (JSON)HTTP Headers for Application and Device identification

Adaptive Payments Developer Guide August 7, 2012 7ContentsPhoneNumberType Response Fields . . . . . . . . . . . . . . . . . . . .

Getting StartedMaking a Parallel Payment (NVP)70 August 7, 2012 Adaptive Payments Developer GuideIn this particular scenario, the paymentExecStatus va

Adaptive Payments Developer Guide August 7, 2012 71Getting StartedMaking a Chained Payment (XML)Making a Chained Payment (XML)A chained payment is whe

Getting StartedMaking a Chained Payment (XML)72 August 7, 2012 Adaptive Payments Developer GuidePay Response for Chained Payment<?xml version=&apos

Adaptive Payments Developer Guide August 7, 2012 733Pay API OperationUse the Pay API operation to transfer funds from a sender’s PayPal account to one

Pay API OperationPay Summary74 August 7, 2012 Adaptive Payments Developer GuideParallel PaymentsFor a simple payment, you must specify values for the

Adaptive Payments Developer Guide August 7, 2012 75Pay API OperationPay SummaryImplicit PaymentsIf you are the API caller and you specify your email a

Pay API OperationPay Summary76 August 7, 2012 Adaptive Payments Developer Guide When the payment is complete, PayPal sends an IPN message to the URL

Adaptive Payments Developer Guide August 7, 2012 77Pay API OperationPayRequest MessagePayRequest MessageThe PayRequest message contains the instructio

Pay API OperationPayRequest Message78 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 79Pay API OperationPayRequest MessagePayRequest FieldsField DescriptionactionType xs:string(Required)

Contents8 August 7, 2012 Adaptive Payments Developer GuidePreapprovalResponse Message . . . . . . . . . . . . . . . . . . . . . .

Pay API OperationPayRequest Message80 August 7, 2012 Adaptive Payments Developer GuidecurrencyCode xs:string(Required) The currency code. Allowable va

Adaptive Payments Developer Guide August 7, 2012 81Pay API OperationPayRequest MessagefundingConstraint ap:FundingConstraint(Optional) Specifies a lis

Pay API OperationPayRequest Message82 August 7, 2012 Adaptive Payments Developer GuideClientDetails Fields senderEmail xs:string(Optional) Sender’s em

Adaptive Payments Developer Guide August 7, 2012 83Pay API OperationPayRequest MessageFundingConstraint FieldsFundingTypeList FieldspartnerName xs:st

Pay API OperationPayRequest Message84 August 7, 2012 Adaptive Payments Developer GuideFundingTypeInfo FieldsReceiverList FieldsReceiver FieldsField De

Adaptive Payments Developer Guide August 7, 2012 85Pay API OperationPayRequest MessagePhoneNumberType FieldspaymentType xs:string(Optional) The transa

Pay API OperationPayResponse Message86 August 7, 2012 Adaptive Payments Developer GuideSenderIdentifier FieldsAccountIdentifier FieldsRequestEnvelope

Adaptive Payments Developer Guide August 7, 2012 87Pay API OperationPayResponse Message

Pay API OperationPayResponse Message88 August 7, 2012 Adaptive Payments Developer Guide

Adaptive Payments Developer Guide August 7, 2012 89Pay API OperationPayResponse Message

Adaptive Payments Developer Guide August 7, 2012 9ContentsCancelPreapproval Errors . . . . . . . . . . . . . . . . . . . . . .

Pay API OperationPayResponse Message90 August 7, 2012 Adaptive Payments Developer GuidePayResponse FieldsField DescriptionpayKey xs:stringThe pay key,

Adaptive Payments Developer Guide August 7, 2012 91Pay API OperationPayResponse MessagePayErrorList FieldsFundingPlan FieldsCurrencyType FieldsField D

Pay API OperationPayResponse Message92 August 7, 2012 Adaptive Payments Developer GuideFundingSource Fieldscode xs:stringThe currency code for the con

Adaptive Payments Developer Guide August 7, 2012 93Pay API OperationPayResponse MessageCurrencyConversion FieldsFundingPlanCharge Fieldstype xs:string

Pay API OperationPayResponse Message94 August 7, 2012 Adaptive Payments Developer GuidePayError FieldsErrorData FieldsField Descriptionerror Detailed

Adaptive Payments Developer Guide August 7, 2012 95Pay API OperationPayResponse MessageReceiver FieldsPhoneNumberType Response FieldsField Description

Pay API OperationPPFault Message96 August 7, 2012 Adaptive Payments Developer GuideResponseEnvelope FieldsPPFault MessageThe PPFaultMessage returns Er

Adaptive Payments Developer Guide August 7, 2012 97Pay API OperationPPFault MessageFaultMessage FieldsField Descriptionerror common:ErrorDataDetailed

Pay API OperationPPFault Message98 August 7, 2012 Adaptive Payments Developer GuideErrorData FieldsResponseEnvelope FieldsField Descriptioncategory co

Adaptive Payments Developer Guide August 7, 2012 99Pay API OperationPay Examples Using NVP and CURLPay Examples Using NVP and CURLThese examples all u