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
4 August 7, 2012 Adaptive Payments Developer Guide
Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . .65
Adaptive Payments API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
API Operations Related to Payments . . . . . . . . . . . . . . . . . . . . . . . . . . 65
API Operations Related to Preapprovals . . . . . . . . . . . . . . . . . . . . . . . . 65
Other API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Adaptive Payments Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
HTTP Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Specifying JSON, NVP, or XML Data Formats. . . . . . . . . . . . . . . . . . . . . . 67
SOAP Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Specifying Application and Device Information . . . . . . . . . . . . . . . . . . . . . 68
Making a Simple Payment (JSON). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Pay Request for Simple Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Pay Response for Simple Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Making a Parallel Payment (NVP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Pay Request for Parallel Payment. . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Pay Response for Parallel Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Making a Chained Payment (XML) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Pay Request for Chained Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Pay Response for Chained Payment . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Chapter 3 Pay API Operation . . . . . . . . . . . . . . . . . . . . . .73
Pay Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Common Fields for All Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Parallel Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chained Payments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Implicit Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Preapproved Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Payments for Digital Goods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Payment Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Additional Notes About the Pay API Operation . . . . . . . . . . . . . . . . . . . . . 76
PayRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
PayRequest Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
ClientDetails Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
FundingConstraint Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
FundingTypeList Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
FundingTypeInfo Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ReceiverList Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Receiver Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84