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 153
SetPaymentOptions API Operation
SetPaymentsOptionsRequest Message
DisplayOptions Fields
InitiatingEntity Fields
receiverOptions ap:ReceiverOptions
(Optional) Specifies information about each receiver.
requestEnvelope common:requestEnvelope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
Field Description
emailHeaderImageUrl xs:string
(Optional) The URL of the image that displays in the in the header of customer
emails. The URL cannot exceed 1,024 characters. The image dimensions are
43 pixels high x 240 pixels wide.
emailMarketingImageUrl xs:string
(Optional) The URL of the image that displays in the in customer emails. The
URL cannot exceed 1,024 characters. The image dimensions are 80 pixels high
x 530 pixels wide.
headerImageUrl xs:string
(Optional) The URL of an image that displays in the header of a payment
page. If set, it overrides the header image URL specified in your account’s
Profile. The URL cannot exceed 1,024 characters. The image dimensions are
90 pixels high x 750 pixels wide.
businessName xs:string
(Optional) The business name to display. The name cannot exceed 128
characters.
Field Description
institutionCustomer ap:InstitutionCustomer
(Optional) Details about the party that initiated this payment. This payment is
made by the API caller on behalf of the initiating party. The initiating party can
be an institution or a customer of the institution. The initiating party must be
set up by PayPal Merchant Services.
Field Description