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
Refund API Operation
RefundRequest Message
216 August 7, 2012 Adaptive Payments Developer Guide
Field Description
currencyCode (Required) The currency code. You must specify the currency code used for
the original payment. You do not need to specify this field if you use a
payKey to refund a complete transaction.
Allowable values are:
Australian Dollar – AUD
Brazilian Real – BRL
NOTE: The Real is supported as a payment currency and currency balance
only for Brazilian PayPal accounts.
Canadian Dollar – CAD
Czech Koruna – CZK
Danish Krone – DKK
Euro – EUR
Hong Kong Dollar – HKD
Hungarian Forint – HUF
Israeli New Sheqel – ILS
Japanese Yen – JPY
Malaysian Ringgit – MYR
NOTE: The Ringgit is supported as a payment currency and currency balance
only for Malaysian PayPal accounts.
Mexican Peso – MXN
Norwegian Krone – NOK
New Zealand Dollar – NZD
Philippine Peso – PHP
Polish Zloty – PLN
Pound Sterling – GBP
Singapore Dollar – SGD
Swedish Krona – SEK
Swiss Franc – CHF
Taiwan New Dollar – TWD
Thai Baht – THB
Turkish Lira – TRY
NOTE: The Turkish Lira is supported as a payment currency and currency
balance only for Turkish PayPal accounts.
U.S. Dollar – USD
payKey xs:string
(Optional) The key used to create the payment that you want to refund.