2012
Table Of Contents
- Name-Value Pair API Developer Guide
- Contents
- What’s New
- Preface
- PayPal Name-Value Pair API Basics
- AddressVerify API Operation
- Authorization and Capture API Operation Reference
- DoDirectPayment API Operation
- DoNonReferencedCredit API Operation
- ExpressCheckout API Operations
- GetBalance API Operation
- GetPalDetails API Operation
- GetTransactionDetails API Operation
- ManagePendingTransactionStatus API Operation
- MassPay API Operation
- Recurring Payments and Reference Transactions API Operations
- CreateRecurringPaymentsProfile API Operation
- GetRecurringPaymentsProfileDetails API Operation
- ManageRecurringPaymentsProfileStatus API Operation
- BillOutstandingAmount API Operation
- UpdateRecurringPaymentsProfile API Operation
- CreateBillingAgreement API Operation
- SetCustomerBillingAgreement API Operation
- GetBillingAgreementCustomerDetails API Operation
- BAUpdate API Operation
- DoReferenceTransaction API Operation
- RefundTransaction API Operation
- TransactionSearch API Operation
- API Error Codes
- General API Errors
- Validation Errors
- DirectPayment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- MassPay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Countries and Regions Supported by PayPal
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
- About Previous Versions of the API
- Revision History
- Index
RefundTransaction API Operation
RefundTransaction Request Message
13
186 August 2012 Name-Value Pair API Developer Guide
Merchant Store Details Fields
RETRYUNTIL (Optional) Maximum time until you must retry the refund.
NOTE: This field does not apply to point-of-sale transactions.
This field is available since version 82.0.
REFUNDSOURCE (Optional)Type of PayPal funding source (balance or eCheck) that can be used for
auto refund. It is one of the following values:
any – The merchant does not have a preference. Use any available funding
source.
default – Use the merchant’s preferred funding source, as configured in the
merchant’s profile.
instant – Use the merchant’s balance as the funding source.
eCheck – The merchant prefers using the eCheck funding source. If the
merchant’s PayPal balance can cover the refund amount, use the PayPal balance.
NOTE: This field does not apply to point-of-sale transactions.
This field is available since version 82.0.
MERCHANTSTOREDETAIL
S
(Optional) Information about the merchant store.
This field is available since version 82.0.
REFUNDADVICE (Optional) Flag to indicate that the buyer was already given store credit for a given
transaction. It is one of the following values:
true – The buyer was already given store credit for a given transaction.
false – The buyer was not given store credit for a given transaction.
This field is available since version 85.0.
REFUNDITEMDETAILS (Optional) Details about the individual items to be returned.
MSGSUBID (Optional) A message ID used for idempotence to uniquely identify a message. This
ID can later be used to request the latest results for a previous request without
generating a new request. Examples of this include requests due to timeouts or errors
during the original request.
Character length and limitations: string of up to 38 single-byte characters.
This field is available since version 92.0.
Field Description
STOREID Identifier of the merchant store at which the refund is given. This field is
required for point-of-sale transactions.
Character length and limitations: 50 single-byte characters
This field is available since version 82.0.
Field Description