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 11
Contents
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250
GetShippingAddresses Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251
Chapter 15 Adaptive Payment Commands and Redirects . . . . . . . 253
Adaptive Payment Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253
_ap-payment Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253
_ap-preapproval Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254
Embedded Payment Flow Redirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254
JavaScript Functions for Embedded Payments . . . . . . . . . . . . . . . . . . . . .255
Chapter 16 Instant Payment Notifications . . . . . . . . . . . . . . . 257
Pay Message Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
Preapproval Message Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .260
Older Versions of the Adaptive Payments API . . . . . . . . . . . . . 263
1.8.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
Changes to SenderOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
Changes to ConvertCurrencyRequest Fields for Version 1.8.0 . . . . . . . . . . . . .264
Changes to JavaScript Functions for Embedded Payments. . . . . . . . . . . . . . .264
New JavaScript Function for Version 1.8.0: AutoRedirectOnDone . . . . . . . . . . .264
1.7.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .265
New API Operations for Version 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . .266
Changes to ConfirmPreapprovalRequest Fields for Version 1.7.0 . . . . . . . . . . .266
Changes to JavaScript Functions for Embedded Payments. . . . . . . . . . . . . . .266
1.6.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .266
New API Operations for Version 1.6.0 . . . . . . . . . . . . . . . . . . . . . . . . . .266
Changes to PayRequest Fields for Version 1.6.0 . . . . . . . . . . . . . . . . . . . .267
Changes to PayResponse Fields for Version 1.6.0 . . . . . . . . . . . . . . . . . . .267
Changes to ExecutePaymentRequest Fields for Version 1.6.0 . . . . . . . . . . . . .267
Changes to GetPaymentOptionsResponse Fields for Version 1.6.0 . . . . . . . . . .267
Changes to SetPaymentOptionsRequest Fields for Version 1.6.0 . . . . . . . . . . .268
Changes to PreapprovalRequest Fields for Version 1.6.0. . . . . . . . . . . . . . . .268
Changes to Address Structure for Version 1.6.0. . . . . . . . . . . . . . . . . . . . .268
Changes to DisplayOptions Structure for Version 1.6.0 . . . . . . . . . . . . . . . . .268
New CurrencyConversion Structure for Version 1.6.0 . . . . . . . . . . . . . . . . .269
New InvoiceData Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . . . .269