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
PaymentDetails API Operation
PaymentDetailsResponse Message
118 August 7, 2012 Adaptive Payments Developer Guide
Receiver Fields
receiver ap:Receiver
The receiver of the payment.
refundedAmount xs:decimal
The total amount refunded for this payment since the payment occurred.
senderTransactionId xs:string
The transaction identification number of the sender of the payment.
senderTransactionStatus xs:string
The transaction status of the payment.
Possible values are:
COMPLETED – The sender’s transaction has completed
PENDING – The transaction is awaiting further processing
CREATED – The payment request was received; funds will be transferred
once approval is received
PARTIALLY_REFUNDED– Transaction was partially refunded
DENIED – The transaction was rejected by the receiver
PROCESSING – The transaction is in progress
REVERSED – The payment was returned to the sender
REFUNDED – The payment was refunded
FAILED – The payment failed
transactionId xs:string
PayPal transaction ID for this payment to the specified receiver.
transactionStatus xs:string
PayPal transaction status.
Possible values are:
COMPLETED – The sender’s transaction has completed
PENDING – The transaction is awaiting further processing
CREATED – The payment request was received; funds will be transferred
once approval is received
PARTIALLY_REFUNDED– Transaction was partially refunded
DENIED – The transaction was rejected by the receiver
PROCESSING – The transaction is in progress
REVERSED – The payment was returned to the sender
REFUNDED – The payment was refunded
FAILED – The payment failed
Field Description
amount xs:decimal
Amount to be paid to the receiver.
Field Description