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
Adaptive Payments Developer Guide August 7, 2012 9
Contents
CancelPreapproval Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196
Chapter 11 ConvertCurrency API Operation. . . . . . . . . . . . . . 197
ConvertCurrencyRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197
ConvertCurrencyRequest Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . .197
CurrencyType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198
CurrencyList Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200
CurrencyCodeList Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
ConversionType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
ConvertCurrencyResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
ConversionCurrencyResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . .203
CurrencyConversionTable Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . .203
CurrencyConversionList Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
CurrencyType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
CurrencyList Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
ConvertCurrency Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
Chapter 12 Refund API Operation . . . . . . . . . . . . . . . . . . . 211
Refund API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
Refund Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213
Additional Notes About the Refund API Operation . . . . . . . . . . . . . . . . . . .213
RefundRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
RefundRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215
ReceiverList Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217
Receiver Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217
PhoneNumberType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
Refund Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
RefundResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
RefundInfoList Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
RefundInfo Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224
Receiver Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224