Developer's Guide
Table Of Contents
- Adaptive Payments Developer Guide
- Contents
- What’s New?
- Introducing Adaptive Payments
- Adaptive Payments Actors and Objects
- Simple, Parallel, and Chained Payments
- Payment Approval
- Adaptive Payments Service Permissions
- Explicit Approval Payment Flow
- Preapproved Payments Flow
- Implicit Approval Payments Flow
- Embedded Payments
- Embedded Payment Flow Presentations
- Kinds of Embedded Payments
- Embedded Payments Implementation Basics
- Embedded Payment Experience
- Preapprove Future Payments Checkbox
- Shipping Address Information
- Embedded Payment Experience
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Lightbox
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Minibrowser
- Displaying and Collecting Shipping Addresses
- Guest Payments
- Fee Payment Configuration
- Getting Started
- Pay API Operation
- PaymentDetails API Operation
- ExecutePayment API Operation
- GetPaymentOptions API Operation
- SetPaymentOptions API Operation
- Preapproval API Operation
- PreapprovalDetails API Operation
- CancelPreapproval API Operation
- ConvertCurrency API Operation
- Refund API Operation
- GetFundingPlans API Operation
- GetShippingAddresses API Operation
- Adaptive Payment Commands and Redirects
- Instant Payment Notifications
- Older Versions of the Adaptive Payments API
- 1.8.0 Features
- 1.7.0 Features
- 1.6.0 Features
- New API Operations for Version 1.6.0
- Changes to PayRequest Fields for Version 1.6.0
- Changes to PayResponse Fields for Version 1.6.0
- Changes to ExecutePaymentRequest Fields for Version 1.6.0
- Changes to GetPaymentOptionsResponse Fields for Version 1.6.0
- Changes to SetPaymentOptionsRequest Fields for Version 1.6.0
- Changes to PreapprovalRequest Fields for Version 1.6.0
- Changes to Address Structure for Version 1.6.0
- Changes to DisplayOptions Structure for Version 1.6.0
- New CurrencyConversion Structure for Version 1.6.0
- New InvoiceData Structure for Version 1.6.0
- New InvoiceItem Structure for Version 1.6.0
- New SenderOptions Structure for Version 1.6.0
- New SenderIdentifier Structure for Version 1.6.0
- New AccountIdentifier Structure for Version 1.6.0
- New ReceiverOptions Structure for Version 1.6.0
- New ReceiverIdentifier Structure for Version 1.6.0
- Additional Error Messages for Version 1.6.0
- 1.5.0 Features
- 1.4.0 Features
- 1.3.0 Features
- 1.2.0 Features
- 1.1.0 Features
- Revision History
- Index
Index
296 August 7, 2012 Adaptive Payments Developer Guide
N
name request field 155
name response field 145
P
parameter field 94, 98, 122, 131, 134, 148, 159, 173,
186, 195, 208, 224, 227, 241, 250
Pay API operation 73
Pay Message variables 257
pay_key IPN variable 259
payError response field 91, 130
PayError response fields 94, 130
payErrorList response field 90, 130
PayErrorList response fields 91, 130
payKey request field 127, 139, 152, 216, 234
payKey response field 90, 115, 141
payment_request_date IPN variable 258
PaymentDetails API operation 109
PaymentDetailsRequest message 109
PaymentDetailsResponse fields 110, 113
paymentExecStatus response field 90, 130
paymentInfo response field 117
PaymentInfo response fields 117
paymentInfoList response field 115
PaymentInfoList response fields 117
paymentPeriod request fields 168
paymentPeriod response field 182
PAYPAL.apps.DGFlow JavaScript function 255, 264,
266
PayRequest fields 79
PayRequest message 77
PayResponse fields 90
PayResponse message 86
pendingReason response field 117
pendingRefund response field 117
phone request field 86, 156
phone response field 120, 145
phoneNumber request field 85, 156, 218
PhoneNumber request fields 85, 156, 218
phoneNumber response field 96, 120, 145, 225
PhoneNumber response fields 95, 120, 145, 225
pin request field 81
pinType request fields 168
pinType response field 182
PPFault message 96, 121, 133, 146, 158, 171, 185, 193,
206, 226, 240, 248
Preapproval Message variables 260
preapproval_key IPN variable 260
PreapprovalDetails API operation 177
PreapprovalDetailsRequest fields 177
PreapprovalDetailsRequest message 177
PreapprovalDetailsResponse fields 180
PreapprovalDetailsResponse message 178
preapprovalKey request field 81, 177, 191
preapprovalKey response field 115
preapprovalKey response fields 170
PreapprovalRequest fields 165
PreapprovalRequest message 164
PreapprovalResponse fields 170
price request field 155
price response field 145
production environment 66
R
reason_code IPN variable 260
receiver request field 84, 155, 217
receiver response field 94, 118, 130, 144, 222
ReceiverIdentifier request fields 156
ReceiverIdentifier response fields 145
receiverList request field 81, 217
ReceiverList request fields 84, 217
receiverOptions request field 153
ReceiverOptions request fields 155
receiverOptions response field 142
ReceiverOptions response fields 144
referrerCode request field 154
referrrerCode response field 144
Refund API operation 211
refundedAmount response field 118
refundFeeAmount response field 222
refundGrossAmount response field 222
refundHasBecomeFull response field 222
refundInfo response field 222
RefundInfo response fields 222
refundInfoList response field 221
RefundInfoList response fields 222
refundNetAmount response field 222
RefundRequest fields 216
RefundRequest message 214
RefundResponse fields 221
RefundResponse message 219
refundStatus response field 223