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
12 August 7, 2012 Adaptive Payments Developer Guide
New InvoiceItem Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . . . .269
New SenderOptions Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . . .269
New SenderIdentifier Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . .270
New AccountIdentifier Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . .270
New ReceiverOptions Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . . .270
New ReceiverIdentifier Structure for Version 1.6.0 . . . . . . . . . . . . . . . . . . .270
Additional Error Messages for Version 1.6.0. . . . . . . . . . . . . . . . . . . . . . .271
1.5.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
Ability to Delay a Chained Payment Feature in Version 1.5.0 . . . . . . . . . . . . . .273
PaymentDetails Pending Reason Feature in Version 1.5.0 . . . . . . . . . . . . . . .274
1.4.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274
New API Operations for Version 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . .274
Changes to the Pay API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . .276
Changes to the PaymentDetails API Operation . . . . . . . . . . . . . . . . . . . . .276
Changes to the PreapprovalDetails API Operation . . . . . . . . . . . . . . . . . . .278
Changes to the PreapprovalDetails API Operation . . . . . . . . . . . . . . . . . . .278
Changes to the Refund API Operation . . . . . . . . . . . . . . . . . . . . . . . . .279
1.3.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279
Overview of Changes for Version 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . .279
HTTP Header Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280
Changes to the Pay API Operation for Version 1.3.0 . . . . . . . . . . . . . . . . . .281
Changes to the PaymentDetails API Operation for Version 1.3.0 . . . . . . . . . . . .283
1.2.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284
Changes to the Pay API Operation for Version 1.2.0 . . . . . . . . . . . . . . . . . .285
Changes to the Payment Details API Operation for Version 1.2.0. . . . . . . . . . . .285
Changes to Preapproval API Operation for Version 1.2.0 . . . . . . . . . . . . . . . .286
Changes to Preapproval Details API Operation for Version 1.2.0 . . . . . . . . . . . .286
1.1.0 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286
Changes to the Pay API Operation for Version 1.1.0 . . . . . . . . . . . . . . . . . .287
Changes to PaymentDetails API Operation for Version 1.1.0 . . . . . . . . . . . . . .287
Changes to Preapproval API Operation for Version 1.1.0 . . . . . . . . . . . . . . . .289
Changes to PreapprovalDetails API Operation for Version 1.1.0 . . . . . . . . . . . .289
Changes to Refund API Operation for Version 1.1.0 . . . . . . . . . . . . . . . . . .289
Revision History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293