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 223
Refund API Operation
Refund Response Message
refundStatus xs:string
Status of the refund. It is one of the following values:
REFUNDED – Refund successfully completed
REFUNDED_PENDING – Refund awaiting transfer of funds; for example, a
refund paid by eCheck.
NOT_PAID – Payment was never made; therefore, it cannot be refunded.
ALREADY_REVERSED_OR_REFUNDED – Request rejected because the
refund was already made, or the payment was reversed prior to this request.
NO_API_ACCESS_TO_RECEIVER – Request cannot be completed because
you do not have third-party access from the receiver to make the refund.
REFUND_NOT_ALLOWED – Refund is not allowed.
INSUFFICIENT_BALANCE – Request rejected because the receiver from
which the refund is to be paid does not have sufficient funds or the funding
source cannot be used to make a refund.
AMOUNT_EXCEEDS_REFUNDABLE – Request rejected because you
attempted to refund more than the remaining amount of the payment; call
the PaymentDetails API operation to determine the amount already
refunded.
PREVIOUS_REFUND_PENDING – Request rejected because a refund is
currently pending for this part of the payment
NOT_PROCESSED – Request rejected because it cannot be processed at this
time
REFUND_ERROR – Request rejected because of an internal error
PREVIOUS_REFUND_ERROR – Request rejected because another part of
this refund caused an internal error.
refundTransactionStatus xs:string
The status of the refund transaction.
Possible values are:
UNKNOWN – The status of the refund process is unknown.
COMPLETED – The refund process has been completed.
totalOfAllRefunds xs:decimal
The total of all refunds actually paid; does not include pending amounts
NOTE: This field is only available when a partial refund has been requested.
Field Description