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 115
PaymentDetails API Operation
PaymentDetailsResponse Message
fundingtypeList ap:FundingTypeList
Specifies a list of allowed funding selections for the payment. This is a list of
funding selections that can be combined in any order to allow payments to use
the indicated funding type. If this Parameter is omitted, the payment can be
funded by any funding type that is supported for Adaptive Payments.
ipnNotificationUrl xs:string
The URL to which all IPN messages for this payment are sent.
memo xs:string
A note associated with the payment.
payKey xs:string
The pay key that identifies this payment. This is a token that is assigned by the
Pay API after a PayRequest message is received and can be used in other
Adaptive Payments Methods, as well as the cancelURL and returnURL to
identify this payment. The pay key is valid for 3 hours.
paymentInfoList ap:PaymentInfoList
Represents the payment attempt made to a receiver of a PayRequest. If the
execution of the payment has not yet completed, there are no transaction
details returned.
preapprovalKey xs:string
The preapproval key that identifies the preapproval for this payment. This key
can be used in other Adaptive Payment APIs to identify the preapproval.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
returnUrl xs:string
The URL to which the sender’s browser is redirected after approving a
payment on paypal.com. Use the pay key to identify the payment as follows:
payKey=${payKey}.
reverseAllParallelPaymen
tsOnError
xs:string
Whether to reverse parallel payments. Possible values are:
true – Each parallel payment is reversed if an error occurs
false – Each parallel payment is not reversed if an error occurs
sender ap:SenderIdentifer
Sender information.
senderEmail xs:string
The sender’s email address.
Field Description