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 293
Index
Symbols
_ap-payment flow command 253
_ap-preapproval flow command 254
A
ack response field 96, 98, 120, 123, 132, 135, 146, 148,
157, 159, 171, 173, 184, 187, 193, 195, 206, 208,
225, 228, 239, 242, 248, 250
action_type IPN variable 258
actionType request field 79
actionType response field 113
Address response fields 183, 247
addresseeName response field 183, 247
addressId response field 184, 247
AddressList response field 183
addresslist response field 180
AddressList response fields 183
allowed response field 93, 239
allowedFundingType request field 83
amount request field 198
amount response field 91, 204, 237
approved IPN variable 260
approved response field 180
B
backupFundingSource response field 91, 236
BaseAddress request fields 184, 247
baseAddress response field 184, 247
baseAmount response field 204
baseAmountList request field 198
build response field 96, 98, 121, 123, 132, 135, 146,
148, 157, 159, 171, 173, 184, 187, 193, 195, 206,
208, 225, 228, 240, 242, 248, 250
businessName request field 153
businessName response field 142
C
cancel_url IPN variable 259, 260
CancelPreapproval API operation 191
CancelPreapprovalRequest fields 191
CancelPreapprovalRequest message 191
CancelPreapprovalResponse fields 192
CancelPreapprovalResponse message 192
cancelUrl request field 79
cancelUrl request fields 165
cancelUrl response field 113, 180
category field 94, 98, 122, 131, 134, 148, 159, 173,
186, 195, 208, 224, 227, 241, 250
charge response field 91, 93, 237
city response field 184, 247
clientDetails request field 79
clientDetails request fields 165
closeFlow JavaScript function 255
code request field 199
code response field 92, 205, 238
ConversionCurrencyResponse fields 202, 203, 264
conversionType request field 198
ConvertCurrency API operation 197
ConvertCurrencyRequest fields 198
ConvertCurrencyRequest message 197
ConvertCurrencyResponse message 202
convertToCurrencyList request field 198
correlationId response field 96, 99, 121, 123, 132, 135,
146, 149, 157, 160, 171, 174, 185, 187, 193, 196,
206, 209, 226, 228, 240, 242, 248, 251
countryCode request field 85, 156, 198, 218, 264
countryCode response field 95, 120, 143, 145, 154,
184, 225, 247
curPayments response field 180
curPaymentsAmount response field 180
curPeriodAttempts response field 180
curPeriodEndingDate response field 180
currency request field 200
currency response field 205
currencyCode request field 80, 201, 216
currencyCode request fields 166
currencyCode response field 114, 181, 221
CurrencyCodeList request fields 201
currencyConversion response field 91, 237
CurrencyConversion response fields 93, 239