2013

RefundTransaction API Operation
RefundTransaction Request Message
13
186 February 01, 2013 Name-Value Pair API Developer Guide
CURRENCYCODE ISO 4217 3-letter currency code. USD for US Dollars. This field is required for
partial refunds, and is also required for refunds greater than 100%.
Character length and limitations: 3 single-byte characters
NOTE (Optional) Custom memo about the refund.
Character length and limitations: 255 single-byte alphanumeric characters
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