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
Contents
10 August 7, 2012 Adaptive Payments Developer Guide
PhoneNumberType Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . .225
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228
Refund Examples Using NVP and CURL . . . . . . . . . . . . . . . . . . . . . . . . . .228
Refund Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
Chapter 13 GetFundingPlans API Operation . . . . . . . . . . . . . 233
GetFundingPlans Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
Additional Notes About the Pay API Operation . . . . . . . . . . . . . . . . . . . . .233
GetFundingPlansRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
GetFundingPlansRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
GetFundingPlansResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
GetFundingPlansResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . .236
FundingPlan Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
CurrencyType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
FundingSource Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238
CurrencyConversion Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
GetFundingPlan Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
Chapter 14 GetShippingAddresses API Operation . . . . . . . . . . 245
GetShippingAddressesRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . .245
GetShippingAddressesRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . .245
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246
GetShippingAddressesResponse Message . . . . . . . . . . . . . . . . . . . . . . . . .246
GetShippingAddressesResponse Fields . . . . . . . . . . . . . . . . . . . . . . . .247
Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
BaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248