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
Pay API Operation
PayRequest Message
84 August 7, 2012 Adaptive Payments Developer Guide
FundingTypeInfo Fields
ReceiverList Fields
Receiver Fields
Field Description
fundingType xs:string
(Required) 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 field is omitted, the payment
can be funded by any funding type that is supported for Adaptive Payments.
Allowable values are:
ECHECK – Electronic check
BALANCE – PayPal account balance
CREDITCARD – Credit card
NOTE: ECHECK and CREDITCARD include BALANCE implicitly.
NOTE: FundingConstraint is unavailable to API callers with standard
permission levels; for more information, refer to the section Adaptive
Payments Permission Levels.
Field Description
receiver ap:Receiver
(Required) Receiver is the party whose account is credited.
Field Description
amount xs:decimal
(Required) Amount to be paid to the receiver.
email xs:string
Receiver’s email address. This address can be unregistered with paypal.com.
If so, a receiver cannot claim the payment until a PayPal account is linked to
the email address. The PayRequest must pass either an email address or a
phone number.
Maximum length: 127 characters
invoiceId xs:string
(Optional) The invoice number for the payment. This data in this field shows
on the Transaction Details report.
Maximum length: 127 characters