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 95
Pay API Operation
PayResponse Message
Receiver Fields
PhoneNumberType Response Fields
Field Description
amount xs:decimal
Amount to be paid to the receiver.
email xs:string
Receiver’s email address.
Maximum length: 127 characters
invoiceId xs:string
The invoice number for the payment. This data in this field shows on the
Transaction Details report.
Maximum length: 127 characters
paymentType xs:string
The transaction type for the payment.
Possible values are:
GOODS – This is a payment for non-digital goods
SERVICE – This is a payment for services (default)
PERSONAL – This is a person-to-person payment
CASHADVANCE – This is a person-to-person payment for a cash advance
DIGITALGOODS – This is a payment for digital goods
BANK_MANAGED_WITHDRAWAL – This is a person-to-person payment for
bank withdrawals, available only with special permission.
paymentSubType xs:string
The transaction subtype for the payment.
phone common:PhoneNumberType
The receiver’s phone number.
primary xs:boolean
Whether this receiver is the primary receiver. If this field is set to true, this is a
chained payment. If this field shows false, this is a simple or parallel payment.
Possible values are:
true – Primary receiver (chained payment)
false – Secondary receiver (simple/parallel payment)
Field Description
countryCode xs:string
Telephone country code.